Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Document ReadTheDocs preview builds.

This commit is contained in:
Tim Abbott 2021-09-06 12:39:12 -07:00
parent 5151e916ea
commit 1c3517a5de
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/documentation/overview.md
View File

@ -38,6 +38,14 @@ developer documentation is at `docs/` in the Zulip Git repository, and
they are served in production at they are served in production at
[zulip.readthedocs.io](https://zulip.readthedocs.io/en/latest/). [zulip.readthedocs.io](https://zulip.readthedocs.io/en/latest/).
This documentation is hosted by the excellent [ReadTheDocs
service](https://readthedocs.org/). ReadTheDocs automatically [builds
a preview](https://docs.readthedocs.io/en/stable/pull-requests.html)
for every pull request, accessible from a "Details" link in the
"Checks" section of the pull request page. It's nonetheless valuable
to submit a screenshot with any pull request modifying documentation
to help make reviews efficient.
If you want to build the developer documentation locally (e.g. to test If you want to build the developer documentation locally (e.g. to test
your changes), the dependencies are automatically installed as part of your changes), the dependencies are automatically installed as part of
Zulip development environment provisioning, and you can build the Zulip development environment provisioning, and you can build the
@ -61,7 +69,7 @@ table of contents.
You can also usually test your changes by pushing a branch to GitHub You can also usually test your changes by pushing a branch to GitHub
and looking at the content on the GitHub web UI, since GitHub renders and looking at the content on the GitHub web UI, since GitHub renders
Markdown, though that won't be as faithful as the `make html` Markdown, though that won't be as faithful as the `make html`
approach. approach or the preview build.
When editing dependencies for the Zulip documentation, you should edit When editing dependencies for the Zulip documentation, you should edit
`requirements/docs.in` and then run `tools/update-locked-requirements` `requirements/docs.in` and then run `tools/update-locked-requirements`