History

Vikas Parashar e962704c71 Add installation troubleshooting instructions in case of pip failure. Add help for pip install failure during provisioning step of initial vagrant up during developer environment installation. Fixes: #1333.		2016-10-19 12:34:08 -07:00
..
_static	docs: Add Git and GitHub Guide.	2016-10-17 16:18:16 -07:00
images	docs: Add Git and GitHub Guide.	2016-10-17 16:18:16 -07:00
.gitignore	Initial sphinx setup from sphinx-quickstart	2015-08-18 17:31:32 -07:00
Makefile	Initial sphinx setup from sphinx-quickstart	2015-08-18 17:31:32 -07:00
README.md	docs: Explain how to re-build the table of contents.	2016-08-27 11:30:57 -07:00
THIRDPARTY	Bugdown: Remove checked-in CodeHilite extension.	2016-10-16 00:40:08 -07:00
architecture-overview.md	Architecture docs: Reposition backtick for address of Nagios plugin	2016-10-14 16:25:25 -07:00
brief-install-vagrant-dev.md	run-dev: Automate passing --interface='' for vagrant environment.	2016-10-04 10:48:26 -07:00
changelog.md	docs: Update changelog since 1.4.0 release.	2016-09-07 19:51:14 -07:00
code-style.md	Extract media queries to media.css.	2016-08-05 10:32:55 -07:00
conf.py	Release Zulip 1.4.	2016-08-25 10:49:00 -07:00
conversion.md	export: Update conversion docs.	2016-08-13 09:36:08 -07:00
custom-apps.md	docs: Properly capitalize GitHub.	2016-10-17 19:31:50 -04:00
dev-env-first-time-contributors.md	Add installation troubleshooting instructions in case of pip failure.	2016-10-19 12:34:08 -07:00
dev-overview.md	dev-overview: Document cloud server option.	2016-10-10 17:10:39 -07:00
directory-structure.md	Move assets/ to live under static/.	2016-08-26 10:23:38 -07:00
front-end-build-process.md	Update documentaton to reflect Django-Pipeline==1.6.8.	2016-07-09 07:09:55 -07:00
full-text-search.md	Support full text search for all languages using pgroonga.	2016-08-26 21:04:03 -07:00
git-guide.md	docs: Say "Set up" instead of "Setup".	2016-10-18 17:29:00 -07:00
html_css.md	Extract media queries to media.css.	2016-08-05 10:32:55 -07:00
html_unescape.py	Change shebangs from python2.7 to python.	2016-05-29 05:03:08 -07:00
index.rst	docs: Add Git and GitHub Guide.	2016-10-17 16:18:16 -07:00
install-docker-dev.md	Split out docker setup doc.	2016-07-19 14:57:07 -07:00
install-generic-unix-dev.md	Upgrade caspersjs to version 1.1.3. (w/acrefoot)	2016-10-08 12:08:43 -07:00
install-ubuntu-without-vagrant-dev.md	docs: Clean up development environment headings.	2016-08-25 10:40:51 -07:00
integration-guide.md	docs: Properly capitalize GitHub.	2016-10-17 19:31:50 -04:00
life-of-a-request.md	Add extensive views writing documentation.	2016-08-18 12:37:33 -07:00
linters.md	Remove extra new lines at the ends of Zulip authoried files.	2016-09-26 21:05:24 -07:00
logging.md	Improve first-time contributor docs.	2016-05-31 07:47:45 -07:00
markdown.md	docs: Improve several headings.	2016-06-26 09:54:19 -07:00
migration-renumbering.md	Add docs/migration-renumbering.md	2016-07-18 12:02:50 -07:00
mypy.md	docs/mypy.md: Document zerver/lib/type_debug.py.	2016-07-23 14:38:24 -07:00
new-feature-tutorial.md	Update update_realm view path and signature in the new feature tutorial.	2016-08-25 19:35:42 -07:00
pointer.md	Expand pointer and unread counts guide.	2016-08-16 16:17:54 -07:00
prod-authentication-methods.md	docs: Improve Zulip in Production page navigation and ToC.	2016-08-24 14:48:11 -07:00
prod-customize.md	docs: Make headings consistent and use the imperative.	2016-08-24 15:02:14 -07:00
prod-install.md	docs: Fix broken image links on prod install page.	2016-10-11 15:19:43 -07:00
prod-maintain-secure-upgrade.md	docs: Document invite-only streams are hidden from other users.	2016-09-14 10:06:10 -07:00
prod-postgres.md	Move prod postgres details to separate page.	2016-07-12 15:46:10 -07:00
prod-requirements.md	docs: Document Ubuntu 16.04 support in production.	2016-08-25 10:40:51 -07:00
prod-troubleshooting.md	docs: Rename status/debug page to troubleshooting.	2016-08-25 09:37:33 -07:00
queuing.md	Update documentation on development auto-reloading.	2016-06-26 20:20:13 -07:00
readme-symlink.md	Rearrange docs table of contents for coherence.	2016-05-31 09:07:09 -07:00
requirements.readthedocs.txt	Move doc building dependencies to requirements/docs.txt.	2016-06-20 16:05:42 -07:00
roadmap.md	docs: Update roadmap HTML with now-completed issues.	2016-10-16 13:09:28 -07:00
schema-migrations.md	Link to migration-renumbering.html in schema-migrations.md	2016-07-18 12:02:50 -07:00
settings.md	docs: Fix typo in spelling of generate_secrets.	2016-10-05 17:47:14 -07:00
ssl-certificates.md	docs: Move SSL docs to a dedicated page.	2016-08-25 09:37:33 -07:00
testing-with-casper.md	Remove extra new lines at the ends of Zulip authoried files.	2016-09-26 21:05:24 -07:00
testing-with-django.md	docs: Properly capitalize GitHub.	2016-10-17 19:31:50 -04:00
testing-with-node.md	Add introduction to docs on node tests.	2016-10-17 19:46:17 -07:00
testing.md	test-backend: Add convenience arguments to run subsets of the tests.	2016-09-28 11:52:05 -07:00
translating.md	docs: Cleanup typos and language in translating guide.	2016-07-29 14:49:51 -07:00
using-dev-environment.md	Split developer environment usage instructions into new page.	2016-07-19 14:57:07 -07:00
version-control.md	docs: Clarify commit message portion of version control docs.	2016-10-05 19:28:21 -07:00
writing-views.md	docs/writing-views: Fix minor typo.	2016-10-15 12:26:40 -07:00

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).

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).