mirror of https://github.com/zulip/zulip.git
docs: Convert reST index pages to Markdown.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg
Tim Abbott
parent
d11d454206
commit
b53e676860
|
|
@ -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
|
||||
```
|
||||
|
|
@ -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
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
# Development environment
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 3
|
||||
---
|
||||
|
||||
Development environment installation <overview>
|
||||
Recommended setup (Vagrant) <setup-vagrant>
|
||||
Advanced setup (non-Vagrant) <setup-advanced>
|
||||
Using the development environment <using>
|
||||
Developing remotely <remote>
|
||||
Authentication in the development environment <authentication>
|
||||
Testing the installer <test-install>
|
||||
```
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
#######################
|
||||
Development environment
|
||||
#######################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
Development environment installation <overview>
|
||||
Recommended setup (Vagrant) <setup-vagrant>
|
||||
Advanced setup (non-Vagrant) <setup-advanced>
|
||||
Using the development environment <using>
|
||||
Developing remotely <remote>
|
||||
Authentication in the development environment <authentication>
|
||||
Testing the installer <test-install>
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Writing documentation
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 3
|
||||
---
|
||||
|
||||
overview
|
||||
user
|
||||
integrations
|
||||
api
|
||||
openapi
|
||||
```
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
#####################
|
||||
Writing documentation
|
||||
#####################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
overview
|
||||
user
|
||||
integrations
|
||||
api
|
||||
openapi
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# Git guide
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 3
|
||||
---
|
||||
|
||||
Quick start <overview>
|
||||
Set up Git <setup>
|
||||
Zulip-specific tools <zulip-tools>
|
||||
How Git is different <the-git-difference>
|
||||
Important Git terms <terminology>
|
||||
Get Zulip code <cloning>
|
||||
Working copies <working-copies>
|
||||
Using Git as you work <using>
|
||||
Pull requests <pull-requests>
|
||||
Collaborate <collaborate>
|
||||
Fixing commits <fixing-commits>
|
||||
Reviewing changes <reviewing>
|
||||
Get and stay out of trouble <troubleshooting>
|
||||
Git cheat sheet <cheat-sheet>
|
||||
```
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
#########
|
||||
Git guide
|
||||
#########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
Quick start <overview>
|
||||
Set up Git <setup>
|
||||
Zulip-specific tools <zulip-tools>
|
||||
How Git is different <the-git-difference>
|
||||
Important Git terms <terminology>
|
||||
Get Zulip code <cloning>
|
||||
Working copies <working-copies>
|
||||
Using Git as you work <using>
|
||||
Pull requests <pull-requests>
|
||||
Collaborate <collaborate>
|
||||
Fixing commits <fixing-commits>
|
||||
Reviewing changes <reviewing>
|
||||
Get and stay out of trouble <troubleshooting>
|
||||
Git cheat sheet <cheat-sheet>
|
||||
|
|
@ -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
|
||||
<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](production/install.md) or [Contributing to
|
||||
Zulip](overview/contributing.md).
|
||||
|
||||
Contents:
|
||||
|
||||
* {ref}`Overview <overview>`
|
||||
* {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>`
|
||||
* {ref}`Translating <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 <https://zulip.readthedocs.io/en/latest/>
|
||||
```
|
||||
115
docs/index.rst
115
docs/index.rst
|
|
@ -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 <https://zulip.com/help>`__, for users and
|
||||
administrators of Zulip organizations.
|
||||
- `Installation documentation <production/install.html>`__, 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.html>`__, 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 `https://zulip.com
|
||||
<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 <production/install.html>`_ or `Contributing to Zulip
|
||||
<overview/contributing.html>`_.
|
||||
|
||||
Contents:
|
||||
|
||||
* :ref:`Overview <overview>`
|
||||
* :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>`
|
||||
* :ref:`Translating <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 <https://zulip.readthedocs.io/en/latest/>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
# Overview
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 3
|
||||
---
|
||||
|
||||
readme
|
||||
contributing
|
||||
architecture-overview
|
||||
directory-structure
|
||||
release-lifecycle
|
||||
changelog
|
||||
```
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
########
|
||||
Overview
|
||||
########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
readme
|
||||
contributing
|
||||
architecture-overview
|
||||
directory-structure
|
||||
release-lifecycle
|
||||
changelog
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# Zulip in production
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 3
|
||||
---
|
||||
|
||||
requirements
|
||||
Installing a production server <install>
|
||||
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
|
||||
```
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
###################
|
||||
Zulip in production
|
||||
###################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
requirements
|
||||
Installing a production server <install>
|
||||
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
|
||||
|
|
@ -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
|
||||
```
|
||||
|
|
@ -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
|
||||
|
|
@ -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
|
||||
```
|
||||
|
|
@ -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
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Translating Zulip
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 3
|
||||
---
|
||||
|
||||
translating
|
||||
internationalization
|
||||
chinese
|
||||
french
|
||||
german
|
||||
hindi
|
||||
polish
|
||||
russian
|
||||
spanish
|
||||
```
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
#################
|
||||
Translating Zulip
|
||||
#################
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
translating
|
||||
internationalization
|
||||
chinese
|
||||
french
|
||||
german
|
||||
hindi
|
||||
polish
|
||||
russian
|
||||
spanish
|
||||
|
|
@ -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
|
||||
```
|
||||
|
|
@ -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
|
||||
Loading…
Reference in New Issue