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

116 lines
2.6 KiB
ReStructuredText
Raw Normal View History

Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
2015-08-18 01:25:12 +02:00
.. zulip documentation master file, created by
sphinx-quickstart on Mon Aug 17 16:24:04 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
docs: Update intro text to index.rst.
2017-11-15 23:31:41 +01:00
Welcome to the Zulip documentation!
===================================
Welcome! Zulip's documentation is split into four parts:
docs: Update URLs to use https://zulip.com. We're migrating to using the cleaner zulip.com domain, which involves changing all of our links from ReadTheDocs and other places to point to the cleaner URL.
2020-06-08 23:04:39 +02:00
- `User documentation <https://zulip.com/help>`__, for users and
docs: Update intro text to index.rst.
2017-11-15 23:31:41 +01:00
administrators of Zulip organizations.
docs: Remove links to production/overview article. We're planning to remove that article as unnecessary.
2018-10-17 00:06:35 +02:00
- `Installation documentation <production/install.html>`__, for
installing and maintaining a production self-hosted Zulip installation.
docs: Update URLs to use https://zulip.com. We're migrating to using the cleaner zulip.com domain, which involves changing all of our links from ReadTheDocs and other places to point to the cleaner URL.
2020-06-08 23:04:39 +02:00
- `API documentation <https://zulip.com/api/>`__, for writing
docs: Fix unnecessary absolute links in docs/.
2017-11-16 20:39:59 +01:00
integrations or bots using the Zulip API.
- `Contributor documentation <overview/contributing.html>`__, for
developing the Zulip software, translating, submitting bug reports,
or making other contributions to the project.
docs: Update intro text to index.rst.
2017-11-15 23:31:41 +01:00
docs: Fix unnecessary absolute links in docs/.
2017-11-16 20:39:59 +01:00
Zulip has well over 150,000 words of documentation. If you can't find
what you're looking for, please `let us know
<contributing/chat-zulip-org.html>`__! Further information on the
Zulip project and its features can be found at `https://www.zulip.org
<https://www.zulip.org>`__.
Rearrange docs table of contents for coherence. The order and structure of the Read The Docs documentation was fairly arbitrary; here's a suggestion for how to change its information architecture so it's more useful to a new contributor. This adds a short Zulip overview, and a table of contents and code contribution intro for new contributors. Fixes: #668. Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
2016-05-14 18:50:19 +02:00
docs: Fix unnecessary absolute links in docs/.
2017-11-16 20:39:59 +01:00
This site contains our installation and contributor documentation. If
this is your first time here, you may want to start with `Production
docs: Remove links to production/overview article. We're planning to remove that article as unnecessary.
2018-10-17 00:06:35 +02:00
installation <production/install.html>`_ or `Contributing to Zulip
docs: Fix unnecessary absolute links in docs/.
2017-11-16 20:39:59 +01:00
<overview/contributing.html>`_.
Rearrange docs table of contents for coherence. The order and structure of the Read The Docs documentation was fairly arbitrary; here's a suggestion for how to change its information architecture so it's more useful to a new contributor. This adds a short Zulip overview, and a table of contents and code contribution intro for new contributors. Fixes: #668. Signed-off-by: Sumana Harihareswara <sumanah@panix.com>
2016-05-14 18:50:19 +02:00
Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
2015-08-18 01:25:12 +02:00
Contents:
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
* :ref:`Overview <overview>`
docs: Fix various capitalization errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 01:47:54 +02:00
* :ref:`Zulip in production <zulip-in-production>`
* :ref:`Development environment <development-environment>`
* :ref:`Developer tutorials <developer-tutorials>`
* :ref:`Git guide <git-guide>`
* :ref:`Code contribution guide <code-contribution-guide>`
* :ref:`Code testing <code-testing>`
* :ref:`Subsystem documentation <subsystem-documentation>`
* :ref:`Writing documentation <writing-documentation>`
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
* :ref:`Translating <translating>`
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
docs: Rename misleading 'user-docs' reference.
2017-05-21 06:50:39 +02:00
.. _overview:
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
2015-08-18 01:25:12 +02:00
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
Initial sphinx setup from sphinx-quickstart (imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
2015-08-18 01:25:12 +02:00
docs: Lint rst files for trailing whitespace.
2017-11-16 22:20:50 +01:00
overview/index
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
docs: Rename misleading 'prod-install-docs' reference.
2017-05-21 06:57:05 +02:00
.. _zulip-in-production:
Move production installation requirements to separate page. To begin the process of consolidating Zulip documentation on Read the Docs, the requirements are now their own topic page, and index.rst links to it. Fixes: #669.
2016-07-12 21:35:25 +02:00
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
production/index
Move production installation requirements to separate page. To begin the process of consolidating Zulip documentation on Read the Docs, the requirements are now their own topic page, and index.rst links to it. Fixes: #669.
2016-07-12 21:35:25 +02:00
docs: Rename misleading 'dev-install-docs' reference.
2017-05-21 07:00:59 +02:00
.. _development-environment:
Move and rearrange developer setup instructions. We aim to consolidate developer documentation on Read The Docs. As a start, this commit turns the first part of README.dev.md into a topic page within /docs/ , and links to it from the doc index. See #669.
2016-07-15 06:51:37 +02:00
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
Move and rearrange developer setup instructions. We aim to consolidate developer documentation on Read The Docs. As a start, this commit turns the first part of README.dev.md into a topic page within /docs/ , and links to it from the doc index. See #669.
2016-07-15 06:51:37 +02:00
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
development/index
Move and rearrange developer setup instructions. We aim to consolidate developer documentation on Read The Docs. As a start, this commit turns the first part of README.dev.md into a topic page within /docs/ , and links to it from the doc index. See #669.
2016-07-15 06:51:37 +02:00
Rename misleading 'tutorial-docs' reference.
2017-05-21 07:07:46 +02:00
.. _developer-tutorials:
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
tutorials/index
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
docs: Split 'git-guide.md`. This should make our Git documentation more readable and less intimidating.
2017-11-23 20:21:57 +01:00
.. _git-guide:
.. toctree::
:maxdepth: 3
git/index
Rename misleading 'code-docs' reference.
2017-05-21 07:09:59 +02:00
.. _code-contribution-guide:
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
contributing/index
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
docs: Extract testing docs to their own TOC section Fixes: #2422.
2016-12-06 12:17:05 +01:00
.. _code-testing:
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
docs: Extract testing docs to their own TOC section Fixes: #2422.
2016-12-06 12:17:05 +01:00
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
testing/index
docs: Extract testing docs to their own TOC section Fixes: #2422.
2016-12-06 12:17:05 +01:00
Rename misleading 'system-docs' reference.
2017-05-21 07:11:00 +02:00
.. _subsystem-documentation:
docs: Reorganize RTD table of contents.
2016-06-17 02:59:41 +02:00
.. toctree::
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
:maxdepth: 3
subsystems/index
docs: Add missing index.rst for documentation/. Apparently I failed to commit this part of our documentation migration.
2019-05-30 02:53:12 +02:00
.. _writing-documentation:
docs: Extract a Writing Documentation top-level section. This should make this easier to find, and also makes "Subsystems" a bit smaller of a catch-all.
2019-05-30 00:39:50 +02:00
.. toctree::
:maxdepth: 3
documentation/index
docs: Reorganize developer docs to improve navigation. This commit helps reduce clutter on the navigation sidebar. Creates new directories and moves relevant files into them. Modifies index.rst, symlinks, and image paths accordingly. This commit also enables expandable/collapsible navigation items, renames files in docs/development and docs/production, modifies /tools/test-documentation so that it overrides a theme setting, Also updates links to other docs, file paths in the codebase that point to developer documents, and files that should be excluded from lint tests. Note that this commit does not update direct links to zulip.readthedocs.io in the codebase; those will be resolved in an upcoming follow-up commit (it'll be easier to verify all the links once this is merged and ReadTheDocs is updated). Fixes #5265.
2017-11-08 17:55:36 +01:00
.. _translating:
.. toctree::
:maxdepth: 3
translating/index
docs: Make index page easy to find. This commit adds an Index link to bottom of nav bar. Fixes #7416.
2017-11-17 21:56:44 +01:00
Index <https://zulip.readthedocs.io/en/latest/>