xref: /plugin/gitbacked/README.md (revision 4075d346d3ebd01e958afc599e003075ff04b464)
1# gitbacked Plugin for DokuWiki
2[![GNU General Public License v2.0](https://img.shields.io/github/license/woolfg/dokuwiki-plugin-gitbacked?label=License)](./LICENSE)
3[![CI](https://github.com/woolfg/dokuwiki-plugin-gitbacked/actions/workflows/dokuwiki.yml/badge.svg)](https://github.com/woolfg/dokuwiki-plugin-gitbacked/actions/workflows/dokuwiki.yml)
4
5## :green_heart: Contributions welcome :green_heart:
6
7You want to support Open Source, even if you are new to the game?
8Feel free to grab an issue:
9
10- [Smaller issues, also well suited for newcomers](https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues?q=is%3Aissue+is%3Aopen+label%3Acontributionwelcome)
11- [Feature requests and other cool ideas](https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22)
12
13If you have encountered a problem, you have a good idea, or just have a question, please, create a new issue.
14
15## gitbacked Plugin for DokuWiki
16
17Store/Sync pages and media files in a git repository
18
19All documentation for this plugin can be found at
20http://www.dokuwiki.org/plugin:gitbacked
21
22This plugin is provided as released DokuWiki installable ZIP packages with detailed [release notes](https://github.com/woolfg/dokuwiki-plugin-gitbacked/blob/master/CHANGELOG.md)
23via this repos [Releases](https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases).
24Detailed technical information on how releases are built can be found at [HowTo manage releases](https://github.com/woolfg/dokuwiki-plugin-gitbacked/blob/master/.github/workflows/docs/HowTo_MANAGE_RELEASES.md).
25
26If you install this plugin manually, make sure that:
27- you download a **released** `dokuwiki-plugin-gitbacked-YYYY-DD-MM.zip` file
28  from the [Release](https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases) page.
29- this file is to be unpacked in `<DOKUWIKI_ROOT>/lib/plugins/gitbacked/` - if this folder
30  is called differently it will not work!
31
32Please refer to http://www.dokuwiki.org/plugins for additional info
33on how to install plugins in DokuWiki.
34
35## Changelog
36
37See [CHANGELOG.md](CHANGELOG.md)
38
39## Maintainers
40
41- [@mhoffrog (Markus Hoffrogge)](https://github.com/mhoffrog)
42- [@woolfg (Wolfgang Gassler)](https://github.com/woolfg)
43
44## License
45
46This plugin is licensed under GPLv2, see [LICENSE](LICENSE).
47
48See the [COPYING](https://github.com/splitbrain/dokuwiki/blob/master/COPYING) file in your DokuWiki folder for details
49