Skip to content

Commit

Permalink
Simplify readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mgruner committed Sep 18, 2023
1 parent 74c978c commit 1653f5c
Showing 1 changed file with 2 additions and 62 deletions.
64 changes: 2 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,7 @@ Source files for Zammad’s user documentation ([latest][docs_latest] / [pre-rel

## 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.

> 🌍 **Wanna help translate?** Submit your contributions
> (or request additional languages) [here][wbetranslate_pre-release].
> Do **NOT** submit a PR with changes to the contents of the `locale/` directory.
Thanks! ❤ ❤ ❤
The Zammad Team

### ReStructuredText Markup

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** ``pre-release`` - if you create
Pull Requests, please use ``pre-release`` as destination Branch.

This will ensure that your changes are available upon merge.
Please see [the Contributing section in this manual](https://docs.zammad.org/en/latest/contributing/start.html).

## Compilation

Expand All @@ -71,34 +33,12 @@ This will ensure that your changes are available upon merge.
```
make html
```

### Localization using Weblate

This documentation is translated via Weblate.
After changing or adding text in this documentation, updating the POT file
is required. (This is usually done by us after QA *before* merging the PR)

Weblate will automatically provide the translation parts in in its UI for
all available languages. If there's translation progress it will automatically
provide pull requests on this repository. 🎉

Pull requests containing direct translations within the PO files will be denied.
Building for a specific language:

```
# ensure clean enviroment
$ make clean
# generate the strings from the *.rst files
$ make gettext
# manual language-based build (`_build/html/`) (for testing)
$ make -e SPHINXOPTS="-D language='de'" html
$ make -e SPHINXOPTS="-D language='en'" html
```

If you have a problem with creating / building the documentation,
please create an issue. Thanks.

### Localization progress

[![Translation progress][tprogress]][wbetranslate_pre-release]
Expand Down

0 comments on commit 1653f5c

Please sign in to comment.