-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
64 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,79 @@ | ||
[![Documentation Status](https://readthedocs.org/projects/zammad/badge/?version=pre-release)](https://docs.zammad.org/en/latest/?badge=pre-release) | ||
|
||
# Zammad Documentation | ||
|
||
If you want to contribute to the Zammad documentation, just create pull | ||
requests. | ||
Source files for [Zammad’s | ||
documentation][docs]. | ||
|
||
## Contributing | ||
|
||
If you would like to improve the docs, | ||
simply: | ||
|
||
1. fork the repo, | ||
2. edit the appropriate `.rst` files | ||
(see [Markup Format] | ||
(#restructuredtext-markup) below), | ||
and | ||
3. submit a pull request. | ||
|
||
Thanks! ❤ ❤ ❤ | ||
The Zammad Team | ||
|
||
## Documentation | ||
### ReStructuredText Markup | ||
|
||
Zammad hosts a searchable version of this documentation at | ||
https://docs.zammad.org | ||
If you like to edit the docs, use the | ||
ReStructuredText markup language. | ||
Information about this markup language | ||
can be found at: | ||
|
||
- http://www.sphinx-doc.org/en/stable/ | ||
rest.html | ||
- https://docutils.sourceforge.io/rst. | ||
html | ||
|
||
### Versioning | ||
|
||
This documentation provides versions: | ||
|
||
- ``pre-release`` can contain develop, | ||
not yet released functions and changes | ||
- ``main`` is the ``latest`` (and | ||
stable) version of the repository | ||
- ``stable-x.x`` is the old back port | ||
for an earlier version | ||
- These branches do not receive | ||
further updates and serve as | ||
historic help | ||
for administrators | ||
|
||
## Notes on Documentation Branches and Pull Requests | ||
|
||
Please note that this repository uses protected branches. | ||
The most current version is **always** ``main`` - if you create Pull Requests, | ||
please use ``main`` as destination Branch. | ||
Please note that this repository uses | ||
protected branches. | ||
The most current version is | ||
**always** ``pre-release`` - if you | ||
create | ||
Pull Requests, please use | ||
``pre-release`` as destination Branch. | ||
|
||
This will ensure that your changes are available upon merge. | ||
This will ensure that your changes are | ||
available upon merge. | ||
|
||
## ReStructuredText markup | ||
## Compilation | ||
|
||
If you like to edit the docs use the ReStructuredText markup language. | ||
Information about this language can be found at: | ||
### Dependencies | ||
|
||
- http://www.sphinx-doc.org/en/stable/rest.html | ||
- https://docutils.sourceforge.io/rst.html | ||
* sphinx | ||
|
||
Thanks! ❤ ❤ ❤ | ||
``` | ||
$ pip install -r requirements.txt | ||
``` | ||
|
||
Zammad Team | ||
### Example for a local HTML build | ||
|
||
``` | ||
make html | ||
``` | ||
|
||
[![Documentation Status](https://readthedocs.org/projects/zammad/badge/?version=latest)](https://docs.zammad.org) | ||
[docs]: https://docs.zammad.org/en/latest/ |