Skip to content

Commit

Permalink
Clean-up readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mgruner committed Sep 18, 2023
1 parent 78de545 commit 55efb68
Showing 1 changed file with 3 additions and 54 deletions.
57 changes: 3 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,60 +4,11 @@

# Zammad Documentation

Source files for [Zammad’s
documentation][docs].
Source files for [Zammad’s documentation][https://docs.zammad.org/en/latest/].

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

### 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 Contributiong section in this manual](https://docs.zammad.org/en/latest/contributing/start.html).

## Compilation

Expand All @@ -73,6 +24,4 @@ available upon merge.

```
make html
```

[docs]: https://docs.zammad.org/en/latest/
```

0 comments on commit 55efb68

Please sign in to comment.