798e6faa9e
NVM takes a specific node version and installs the node package and a corresponding compatible npm package. We use it in a somewhat hackish way to install node/npm globally with a pinned version, since that's how we actually want to consume node in our development environment. Other details: - Travis CI now is configured to use the version of node installed by provision; the easiest way to do this was to sabotage the existing node installation. - jsdom is upgraded to a current version, which both requires recent node and also is required for the tests to pass with recent node. This fixes running the node tests on Xenial. Fixes #1498. [tweaked by tabbott] |
||
|---|---|---|
| .. | ||
| _static | ||
| images | ||
| .gitignore | ||
| architecture-overview.md | ||
| brief-install-vagrant-dev.md | ||
| changelog.md | ||
| code-style.md | ||
| conf.py | ||
| conversion.md | ||
| custom-apps.md | ||
| dev-env-first-time-contributors.md | ||
| dev-overview.md | ||
| directory-structure.md | ||
| front-end-build-process.md | ||
| full-text-search.md | ||
| html_css.md | ||
| html_unescape.py | ||
| index.rst | ||
| install-docker-dev.md | ||
| install-generic-unix-dev.md | ||
| install-ubuntu-without-vagrant-dev.md | ||
| integration-guide.md | ||
| life-of-a-request.md | ||
| linters.md | ||
| logging.md | ||
| Makefile | ||
| markdown.md | ||
| migration-renumbering.md | ||
| mypy.md | ||
| new-feature-tutorial.md | ||
| pointer.md | ||
| prod-authentication-methods.md | ||
| prod-customize.md | ||
| prod-install.md | ||
| prod-maintain-secure-upgrade.md | ||
| prod-postgres.md | ||
| prod-requirements.md | ||
| prod-troubleshooting.md | ||
| queuing.md | ||
| readme-symlink.md | ||
| README.md | ||
| requirements.readthedocs.txt | ||
| roadmap.md | ||
| schema-migrations.md | ||
| settings.md | ||
| ssl-certificates.md | ||
| testing-with-casper.md | ||
| testing-with-django.md | ||
| testing-with-node.md | ||
| testing.md | ||
| THIRDPARTY | ||
| translating.md | ||
| using-dev-environment.md | ||
| version-control.md | ||
| writing-views.md | ||
Documentation
These docs are written in Commonmark Markdown with a small bit of rST. We've chosen Markdown because it is easy to write. The docs are served in production at zulip.readthedocs.io.
If you want to build the documentation locally (e.g. to test your changes), the dependencies are automatically installed as part of Zulip development environment provisioning, and you can build the documentation using:
cd docs/
make html
and then opening file:///path/to/zulip/docs/_build/html/index.html in
your browser (you can also use e.g. firefox docs/_build/html/index.html from the root of your Zulip checkout).
If you are introducing a new section into the table of contents,
you will want to modify docs/index.rst and run make clean before
make html, so that other docs besides your new one also get the
new entry in the table of contents.
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 Markdown.
When editing dependencies for the Zulip documentation, you should edit
requirements/docs.txt (which is used by ReadTheDocs to build the
documentation quickly, without installing all of Zulip's dependencies).