683f49aa99
This adds support for using PGroonga to back the Zulip full-text search feature. Because built-in PostgreSQL full text search doesn't support languages that don't put space between terms such as Japanese, Chinese and so on. PGroonga supports all languages including Japanese and Chinese. Developers will need to re-provision when rebasing past this patch for the tests to pass, since provision is what installs the PGroonga package and extension. PGroonga is enabled by default in development but not in production; the hope is that after the PGroonga support is tested further, we can enable it by default. Fixes #615. [docs and tests tweaked by tabbott] |
||
|---|---|---|
| .. | ||
| _static | ||
| images | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| THIRDPARTY | ||
| architecture-overview.md | ||
| brief-install-vagrant-dev.md | ||
| changelog.md | ||
| code-style.md | ||
| conf.py | ||
| conversion.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 | ||
| 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 | ||
| 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 | ||
| translating.md | ||
| using-dev-environment.md | ||
| version-control.md | ||
| writing-views.md | ||
README.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).
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).