From b53e67686011f7ed16c36dbb5d9a25f2aabaf052 Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Thu, 19 Aug 2021 21:12:57 -0700 Subject: [PATCH] docs: Convert reST index pages to Markdown. Signed-off-by: Anders Kaseorg --- docs/contributing/index.md | 17 +++++ docs/contributing/index.rst | 16 ----- docs/development/index.md | 15 ++++ docs/development/index.rst | 14 ---- docs/documentation/index.md | 13 ++++ docs/documentation/index.rst | 12 ---- docs/git/index.md | 22 ++++++ docs/git/index.rst | 21 ------ docs/index.md | 129 +++++++++++++++++++++++++++++++++++ docs/index.rst | 115 ------------------------------- docs/overview/index.md | 14 ++++ docs/overview/index.rst | 13 ---- docs/production/index.md | 26 +++++++ docs/production/index.rst | 25 ------- docs/subsystems/index.md | 40 +++++++++++ docs/subsystems/index.rst | 39 ----------- docs/testing/index.md | 18 +++++ docs/testing/index.rst | 17 ----- docs/translating/index.md | 17 +++++ docs/translating/index.rst | 16 ----- docs/tutorials/index.md | 14 ++++ docs/tutorials/index.rst | 13 ---- 22 files changed, 325 insertions(+), 301 deletions(-) create mode 100644 docs/contributing/index.md delete mode 100644 docs/contributing/index.rst create mode 100644 docs/development/index.md delete mode 100644 docs/development/index.rst create mode 100644 docs/documentation/index.md delete mode 100644 docs/documentation/index.rst create mode 100644 docs/git/index.md delete mode 100644 docs/git/index.rst create mode 100644 docs/index.md delete mode 100644 docs/index.rst create mode 100644 docs/overview/index.md delete mode 100644 docs/overview/index.rst create mode 100644 docs/production/index.md delete mode 100644 docs/production/index.rst create mode 100644 docs/subsystems/index.md delete mode 100644 docs/subsystems/index.rst create mode 100644 docs/testing/index.md delete mode 100644 docs/testing/index.rst create mode 100644 docs/translating/index.md delete mode 100644 docs/translating/index.rst create mode 100644 docs/tutorials/index.md delete mode 100644 docs/tutorials/index.rst diff --git a/docs/contributing/index.md b/docs/contributing/index.md new file mode 100644 index 0000000000..c658f74b67 --- /dev/null +++ b/docs/contributing/index.md @@ -0,0 +1,17 @@ +# Code contribution guide + +```{toctree} +--- +maxdepth: 3 +--- + +version-control +code-style +code-reviewing +zulipbot-usage +accessibility +bug-reports +../code-of-conduct +gsoc-ideas +summer-with-zulip +``` diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst deleted file mode 100644 index e233722bd4..0000000000 --- a/docs/contributing/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -####################### -Code contribution guide -####################### - -.. toctree:: - :maxdepth: 3 - - version-control - code-style - code-reviewing - zulipbot-usage - accessibility - bug-reports - ../code-of-conduct - gsoc-ideas - summer-with-zulip diff --git a/docs/development/index.md b/docs/development/index.md new file mode 100644 index 0000000000..40075452fb --- /dev/null +++ b/docs/development/index.md @@ -0,0 +1,15 @@ +# Development environment + +```{toctree} +--- +maxdepth: 3 +--- + +Development environment installation +Recommended setup (Vagrant) +Advanced setup (non-Vagrant) +Using the development environment +Developing remotely +Authentication in the development environment +Testing the installer +``` diff --git a/docs/development/index.rst b/docs/development/index.rst deleted file mode 100644 index 1acd420869..0000000000 --- a/docs/development/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -####################### -Development environment -####################### - -.. toctree:: - :maxdepth: 3 - - Development environment installation - Recommended setup (Vagrant) - Advanced setup (non-Vagrant) - Using the development environment - Developing remotely - Authentication in the development environment - Testing the installer diff --git a/docs/documentation/index.md b/docs/documentation/index.md new file mode 100644 index 0000000000..f48e88f5b4 --- /dev/null +++ b/docs/documentation/index.md @@ -0,0 +1,13 @@ +# Writing documentation + +```{toctree} +--- +maxdepth: 3 +--- + +overview +user +integrations +api +openapi +``` diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst deleted file mode 100644 index 9bb3fe9f7c..0000000000 --- a/docs/documentation/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -##################### -Writing documentation -##################### - -.. toctree:: - :maxdepth: 3 - - overview - user - integrations - api - openapi diff --git a/docs/git/index.md b/docs/git/index.md new file mode 100644 index 0000000000..c26d5ccc8f --- /dev/null +++ b/docs/git/index.md @@ -0,0 +1,22 @@ +# Git guide + +```{toctree} +--- +maxdepth: 3 +--- + +Quick start +Set up Git +Zulip-specific tools +How Git is different +Important Git terms +Get Zulip code +Working copies +Using Git as you work +Pull requests +Collaborate +Fixing commits +Reviewing changes +Get and stay out of trouble +Git cheat sheet +``` diff --git a/docs/git/index.rst b/docs/git/index.rst deleted file mode 100644 index 6853d8b19a..0000000000 --- a/docs/git/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -######### -Git guide -######### - -.. toctree:: - :maxdepth: 3 - - Quick start - Set up Git - Zulip-specific tools - How Git is different - Important Git terms - Get Zulip code - Working copies - Using Git as you work - Pull requests - Collaborate - Fixing commits - Reviewing changes - Get and stay out of trouble - Git cheat sheet diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000000..4a81bcb6c1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,129 @@ +# Welcome to the Zulip documentation! + +Welcome! Zulip's documentation is split into four parts: + +- [User documentation](https://zulip.com/help), for users and + administrators of Zulip organizations. +- [Installation documentation](production/install.md), for + installing and maintaining a production self-hosted Zulip installation. +- [API documentation](https://zulip.com/api/), for writing + integrations or bots using the Zulip API. +- [Contributor documentation](overview/contributing.md), for + developing the Zulip software, translating, submitting bug reports, + or making other contributions to the project. + +Zulip has well over 150,000 words of documentation. If you can't find +what you're looking for, please [let us +know](https://zulip.com/developer-community/)! Further information on +the Zulip project and its features can be found at +. + +This site contains our installation and contributor documentation. If +this is your first time here, you may want to start with [Production +installation](production/install.md) or [Contributing to +Zulip](overview/contributing.md). + +Contents: + +* {ref}`Overview ` +* {ref}`Zulip in production ` +* {ref}`Development environment ` +* {ref}`Developer tutorials ` +* {ref}`Git guide ` +* {ref}`Code contribution guide ` +* {ref}`Code testing ` +* {ref}`Subsystem documentation ` +* {ref}`Writing documentation ` +* {ref}`Translating ` + +(overview)= +```{toctree} +--- +maxdepth: 3 +--- + +overview/index +``` + +(zulip-in-production)= +```{toctree} +--- +maxdepth: 3 +--- + +production/index +``` + +(development-environment)= +```{toctree} +--- +maxdepth: 3 +--- + +development/index +``` + +(developer-tutorials)= +```{toctree} +--- +maxdepth: 3 +--- + +tutorials/index +``` + +(git-guide)= +```{toctree} +--- +maxdepth: 3 +--- + +git/index +``` + +(code-contribution-guide)= +```{toctree} +--- +maxdepth: 3 +--- + +contributing/index +``` + +(code-testing)= +```{toctree} +--- +maxdepth: 3 +--- + +testing/index +``` + +(subsystem-documentation)= +```{toctree} +--- +maxdepth: 3 +--- + +subsystems/index +``` + +(writing-documentation)= +```{toctree} +--- +maxdepth: 3 +--- + +documentation/index +``` + +(translating)= +```{toctree} +--- +maxdepth: 3 +--- + +translating/index + +Index +``` diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 5fcfe10db4..0000000000 --- a/docs/index.rst +++ /dev/null @@ -1,115 +0,0 @@ -.. 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. - -Welcome to the Zulip documentation! -=================================== - -Welcome! Zulip's documentation is split into four parts: - -- `User documentation `__, for users and - administrators of Zulip organizations. -- `Installation documentation `__, for - installing and maintaining a production self-hosted Zulip installation. -- `API documentation `__, for writing - integrations or bots using the Zulip API. -- `Contributor documentation `__, for - developing the Zulip software, translating, submitting bug reports, - or making other contributions to the project. - -Zulip has well over 150,000 words of documentation. If you can't find -what you're looking for, please `let us know -`__! Further information on the -Zulip project and its features can be found at `https://zulip.com -`__. - -This site contains our installation and contributor documentation. If -this is your first time here, you may want to start with `Production -installation `_ or `Contributing to Zulip -`_. - -Contents: - -* :ref:`Overview ` -* :ref:`Zulip in production ` -* :ref:`Development environment ` -* :ref:`Developer tutorials ` -* :ref:`Git guide ` -* :ref:`Code contribution guide ` -* :ref:`Code testing ` -* :ref:`Subsystem documentation ` -* :ref:`Writing documentation ` -* :ref:`Translating ` - -.. _overview: - -.. toctree:: - :maxdepth: 3 - - overview/index - -.. _zulip-in-production: - -.. toctree:: - :maxdepth: 3 - - production/index - -.. _development-environment: - -.. toctree:: - :maxdepth: 3 - - development/index - -.. _developer-tutorials: - -.. toctree:: - :maxdepth: 3 - - tutorials/index - -.. _git-guide: - -.. toctree:: - :maxdepth: 3 - - git/index - -.. _code-contribution-guide: - -.. toctree:: - :maxdepth: 3 - - contributing/index - -.. _code-testing: - -.. toctree:: - :maxdepth: 3 - - testing/index - -.. _subsystem-documentation: - -.. toctree:: - :maxdepth: 3 - - subsystems/index - -.. _writing-documentation: - -.. toctree:: - :maxdepth: 3 - - documentation/index - -.. _translating: - -.. toctree:: - :maxdepth: 3 - - translating/index - - Index diff --git a/docs/overview/index.md b/docs/overview/index.md new file mode 100644 index 0000000000..91233c9403 --- /dev/null +++ b/docs/overview/index.md @@ -0,0 +1,14 @@ +# Overview + +```{toctree} +--- +maxdepth: 3 +--- + +readme +contributing +architecture-overview +directory-structure +release-lifecycle +changelog +``` diff --git a/docs/overview/index.rst b/docs/overview/index.rst deleted file mode 100644 index 01c14aaedf..0000000000 --- a/docs/overview/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -######## -Overview -######## - -.. toctree:: - :maxdepth: 3 - - readme - contributing - architecture-overview - directory-structure - release-lifecycle - changelog diff --git a/docs/production/index.md b/docs/production/index.md new file mode 100644 index 0000000000..34e98c580d --- /dev/null +++ b/docs/production/index.md @@ -0,0 +1,26 @@ +# Zulip in production + +```{toctree} +--- +maxdepth: 3 +--- + +requirements +Installing a production server +troubleshooting +management-commands +settings +mobile-push-notifications +upgrade-or-modify +security-model +authentication-methods +export-and-import +postgresql +upload-backends +ssl-certificates +email +deployment +email-gateway +video-calls +giphy-gif-integration +``` diff --git a/docs/production/index.rst b/docs/production/index.rst deleted file mode 100644 index 9415100024..0000000000 --- a/docs/production/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -################### -Zulip in production -################### - -.. toctree:: - :maxdepth: 3 - - requirements - Installing a production server - troubleshooting - management-commands - settings - mobile-push-notifications - upgrade-or-modify - security-model - authentication-methods - export-and-import - postgresql - upload-backends - ssl-certificates - email - deployment - email-gateway - video-calls - giphy-gif-integration diff --git a/docs/subsystems/index.md b/docs/subsystems/index.md new file mode 100644 index 0000000000..fa67863832 --- /dev/null +++ b/docs/subsystems/index.md @@ -0,0 +1,40 @@ +# Subsystems documentation + +```{toctree} +--- +maxdepth: 3 +--- + +dependencies +settings +html-css +events-system +sending-messages +notifications +queuing +pointer +markdown +caching +performance +realms +management-commands +schema-migrations +hashchange-system +emoji +hotspots +full-text-search +email +analytics +client +logging +typing-indicators +django-upgrades +release-checklist +api-release-checklist +input-pills +presence +unread_messages +billing +widgets +slash-commands +``` diff --git a/docs/subsystems/index.rst b/docs/subsystems/index.rst deleted file mode 100644 index c1d20ce694..0000000000 --- a/docs/subsystems/index.rst +++ /dev/null @@ -1,39 +0,0 @@ -######################## -Subsystems documentation -######################## - -.. toctree:: - :maxdepth: 3 - - dependencies - settings - html-css - events-system - sending-messages - notifications - queuing - pointer - markdown - caching - performance - realms - management-commands - schema-migrations - hashchange-system - emoji - hotspots - full-text-search - email - analytics - client - logging - typing-indicators - django-upgrades - release-checklist - api-release-checklist - input-pills - presence - unread_messages - billing - widgets - slash-commands diff --git a/docs/testing/index.md b/docs/testing/index.md new file mode 100644 index 0000000000..e6176d4fa3 --- /dev/null +++ b/docs/testing/index.md @@ -0,0 +1,18 @@ +# Code testing + +```{toctree} +--- +maxdepth: 3 +--- + +testing +linters +testing-with-django +testing-with-node +testing-with-puppeteer +mypy +typescript +continuous-integration +manual-testing +philosophy +``` diff --git a/docs/testing/index.rst b/docs/testing/index.rst deleted file mode 100644 index 9af75f4f09..0000000000 --- a/docs/testing/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -############ -Code testing -############ - -.. toctree:: - :maxdepth: 3 - - testing - linters - testing-with-django - testing-with-node - testing-with-puppeteer - mypy - typescript - continuous-integration - manual-testing - philosophy diff --git a/docs/translating/index.md b/docs/translating/index.md new file mode 100644 index 0000000000..20cf4a5fc4 --- /dev/null +++ b/docs/translating/index.md @@ -0,0 +1,17 @@ +# Translating Zulip + +```{toctree} +--- +maxdepth: 3 +--- + +translating +internationalization +chinese +french +german +hindi +polish +russian +spanish +``` diff --git a/docs/translating/index.rst b/docs/translating/index.rst deleted file mode 100644 index be6f70e472..0000000000 --- a/docs/translating/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -################# -Translating Zulip -################# - -.. toctree:: - :maxdepth: 3 - - translating - internationalization - chinese - french - german - hindi - polish - russian - spanish diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 0000000000..c294de400b --- /dev/null +++ b/docs/tutorials/index.md @@ -0,0 +1,14 @@ +# Developer tutorials + +```{toctree} +--- +maxdepth: 3 +--- + +new-feature-tutorial +writing-views +life-of-a-request +reading-list +screenshot-and-gif-software +shell-tips +``` diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst deleted file mode 100644 index 5f7e10ef31..0000000000 --- a/docs/tutorials/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -################### -Developer tutorials -################### - -.. toctree:: - :maxdepth: 3 - - new-feature-tutorial - writing-views - life-of-a-request - reading-list - screenshot-and-gif-software - shell-tips