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.
This commit is contained in:
Tim Abbott
2019-05-29 15:39:50 -07:00
parent 1a68ef2951
commit fa37c5cee1
14 changed files with 20 additions and 12 deletions

View File

@@ -73,7 +73,7 @@ For many of our project ideas, you'll be working inside a Zulip
development environment (because the documentation is implemented as development environment (because the documentation is implemented as
markdown in the main Zulip repository, and can be previewed using markdown in the main Zulip repository, and can be previewed using
tools in the Zulip development environment). See tools in the Zulip development environment). See
[our documentation on documentation systems](../subsystems/documentation.html) [our documentation on documentation systems](../documentation/overview.html)
for details on our various existing documentation systems. for details on our various existing documentation systems.
In part due to past work by a technical writer, Zulip has a In part due to past work by a technical writer, Zulip has a

View File

@@ -90,13 +90,13 @@ to do the things one does a lot in each type of documentation.
To learn more about Zulip's general user documentation, To learn more about Zulip's general user documentation,
[visit it on zulipchat.com](https://zulipchat.com/help/) or [visit it on zulipchat.com](https://zulipchat.com/help/) or
[read our guide on writing user documentation](user-docs.html). [read our guide on writing user documentation](user.html).
### Integrations documentation ### Integrations documentation
To learn more about Zulip's integrations documentation, To learn more about Zulip's integrations documentation,
[visit it on zulipchat.com](https://zulipchat.com/integrations/) or [visit it on zulipchat.com](https://zulipchat.com/integrations/) or
[read our guide on writing user documentation](integration-docs.html). [read our guide on writing user documentation](integrations.html).
### API documentation ### API documentation

View File

@@ -39,6 +39,7 @@ Contents:
* :ref:`Code Contribution Guide <code-contribution-guide>` * :ref:`Code Contribution Guide <code-contribution-guide>`
* :ref:`Code Testing <code-testing>` * :ref:`Code Testing <code-testing>`
* :ref:`Subsystem Documentation <subsystem-documentation>` * :ref:`Subsystem Documentation <subsystem-documentation>`
* :ref:`Writing Documentation <documentation>`
* :ref:`Translating <translating>` * :ref:`Translating <translating>`
.. _overview: .. _overview:
@@ -97,6 +98,13 @@ Contents:
subsystems/index subsystems/index
.. _documentation:
.. toctree::
:maxdepth: 3
documentation/index
.. _translating: .. _translating:
.. toctree:: .. toctree::

View File

@@ -282,7 +282,7 @@ CSS](https://github.com/zulip/zulip/).
e.g. having built a prototype with e.g. having built a prototype with
[the Django Oauth toolkit](https://django-oauth-toolkit.readthedocs.io/en/latest/) [the Django Oauth toolkit](https://django-oauth-toolkit.readthedocs.io/en/latest/)
would be great to demonstrate as part of an application. The would be great to demonstrate as part of an application. The
[Zulip integration writing guide](../subsystems/integration-docs.html) [Zulip integration writing guide](../documentation/integrations.html)
and and
[integration documentation](https://chat.zulip.org/integrations/) [integration documentation](https://chat.zulip.org/integrations/)
are useful materials for learning about how things currently work, are useful materials for learning about how things currently work,

View File

@@ -131,7 +131,7 @@ translators can understand and preserve those decisions:
Some translated languages don't have these, but we highly encourage Some translated languages don't have these, but we highly encourage
translators for new languages (or those updating a language) write a translators for new languages (or those updating a language) write a
style guide as they work (see [our docs on this style guide as they work (see [our docs on this
documentation](../subsystems/documentation.html) for how to submit documentation](../documentation/overview.html) for how to submit
your changes), since it's easy to take notes as you translate, and your changes), since it's easy to take notes as you translate, and
doing so greatly increases the ability of future translators to update doing so greatly increases the ability of future translators to update
the translations in a consistent way. the translations in a consistent way.

View File

@@ -10,7 +10,7 @@ file in `templates/zerver/help/include/rest-endpoints.md` , so that it appears
in the index in the left sidebar on the `/api` page. in the index in the left sidebar on the `/api` page.
The markdown framework is the same one used by the The markdown framework is the same one used by the
[user docs](../subsystems/user-docs.html), which supports macros and [user docs](../documentation/user.html), which supports macros and
various other features, though we don't use them heavily here. various other features, though we don't use them heavily here.
If you look at the documentation for existing endpoints (see a live If you look at the documentation for existing endpoints (see a live

View File

@@ -145,7 +145,7 @@ information on writing and running tests, see the
After implementing the new feature, you should After implementing the new feature, you should
document it and update any existing documentation that might be document it and update any existing documentation that might be
relevant to the new feature. For more information on the kinds of relevant to the new feature. For more information on the kinds of
documentation Zulip has, see [Documentation](../subsystems/documentation.html). documentation Zulip has, see [Documentation](../documentation/overview.html).
## Example Feature ## Example Feature
@@ -667,4 +667,4 @@ At the very least, this will involve adding (or modifying) a Markdown file
documenting the feature to `templates/zerver/help/` in the main Zulip documenting the feature to `templates/zerver/help/` in the main Zulip
server repository, where the source for Zulip's user documentation is server repository, where the source for Zulip's user documentation is
stored. For information on writing user documentation, see stored. For information on writing user documentation, see
[Zulip's general user guide documentation](../subsystems/user-docs.html). [Zulip's general user guide documentation](../documentation/user.html).

View File

@@ -415,7 +415,7 @@ for further details, including how to easily create the message
screenshot. Mostly you should plan on templating off an existing guide, like screenshot. Mostly you should plan on templating off an existing guide, like
[this one](https://raw.githubusercontent.com/zulip/zulip/master/zerver/webhooks/github/doc.md). [this one](https://raw.githubusercontent.com/zulip/zulip/master/zerver/webhooks/github/doc.md).
[integration-docs-guide]: https://zulip.readthedocs.io/en/latest/subsystems/integration-docs.html [integration-docs-guide]: https://zulip.readthedocs.io/en/latest/documentation/integrations.html
## Step 7: Preparing a pull request to zulip/zulip ## Step 7: Preparing a pull request to zulip/zulip

View File

@@ -34,7 +34,7 @@ from this configuration to actually do the work (that way, it's
possible to update the script without breaking users' configurations). possible to update the script without breaking users' configurations).
* Be sure to test your integration carefully and * Be sure to test your integration carefully and
[document](https://zulip.readthedocs.io/en/latest/subsystems/integration-docs.html) [document](https://zulip.readthedocs.io/en/latest/documentation/integrations.html)
how to install it. how to install it.
* You should specify a clear HTTP User-Agent for your integration. The * You should specify a clear HTTP User-Agent for your integration. The

View File

@@ -8,7 +8,7 @@
# #
# Our own documentation lives at # Our own documentation lives at
# #
# https://zulip.readthedocs.io/en/latest/subsystems/openapi-api-docs.html # https://zulip.readthedocs.io/en/latest/documentation/openapi.html
# #
# Basic Swagger UI info # Basic Swagger UI info
swagger: '2.0' swagger: '2.0'

View File

@@ -4,7 +4,7 @@
# #
# Our own documentation lives at # Our own documentation lives at
# #
# https://zulip.readthedocs.io/en/latest/subsystems/openapi-api-docs.html # https://zulip.readthedocs.io/en/latest/documentation/openapi.html
# #
openapi: 3.0.1 openapi: 3.0.1