Skip to content

Commit cfabe40

Browse files
authored
Feat: add devcontainer to README.md
1 parent 4f25cc8 commit cfabe40

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,12 @@ Please see [the Contributing section in this manual](https://docs.zammad.org/en/
1414

1515
### Dependencies
1616

17+
Either install the dependencies on your machine or use a devcontainer, see next section.
18+
1719
* sphinx
1820

1921
```
20-
$ pip install sphinx sphinx-autobuild sphinx-intl sphinx_rtd_theme sphinx-tabs sphinx-version-warning
22+
$ pip install -r requirements.txt
2123
```
2224

2325
* gettext
@@ -28,20 +30,37 @@ Please see [the Contributing section in this manual](https://docs.zammad.org/en/
2830
$ sudo dnf install gettext # Fedora
2931
```
3032

33+
### Devcontainer
34+
35+
If you can't or don't want to install the dependencies on your system, you can use a devcontainer. The repo
36+
is prepared so you just need a supported editor (e.g. VS Code) and a Docker installation on your system.
37+
38+
Simply open the cloned repo in a supported editor and it should ask you to open the folder in a container. After it got
39+
set up, you can compile the docs with your changes locally.
40+
41+
For more information, check these resources:
42+
43+
- https://github.com/devcontainers/
44+
- https://containers.dev/
45+
3146
### Example for a local HTML build
3247

3348
```
34-
make html
49+
$ make html
3550
```
3651
Building for a specific language:
3752

3853
```
3954
$ make -e SPHINXOPTS="-D language='en'" html
4055
```
4156

42-
### Localization progress
57+
### Update of Translation Catalog
58+
59+
Before creating a pull request, make sure to update the translation catalog after your last changes:
4360

44-
[![Translation progress][tprogress]][wbetranslate_pre-release]
61+
```
62+
$ make gettext
63+
```
4564

4665
[badge_latest]: https://readthedocs.org/projects/zammad-user-documentation/badge/?version=latest
4766
[docs_latest]: https://user-docs.zammad.org/en/latest/
@@ -55,4 +74,3 @@ $ make -e SPHINXOPTS="-D language='en'" html
5574
[tbadge_pre-release]: https://translations.zammad.org/widget/documentations/user-documentation-pre-release/svg-badge.svg
5675
[wbetranslate_pre-release]: https://translations.zammad.org/projects/documentations/user-documentation-pre-release/
5776

58-
[tprogress]: https://translations.zammad.org/widget/documentations/user-documentation-pre-release/multi-auto.svg

0 commit comments

Comments
 (0)