diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f70bb0f920..a235e07dd6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,11 +5,11 @@ Welcome to the Zulip community! ## Community The -[Zulip community server](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html) +[Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html) is the primary communication forum for the Zulip community. It is a good place to start whether you have a question, are a new contributor, are a new user, or anything else. Make sure to read the -[community norms](http://zulip.readthedocs.io/en/latest/chat-zulip-org.html#community-norms) +[community norms](http://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html#community-norms) before posting. The Zulip community is also governed by a [code of conduct](http://zulip.readthedocs.io/en/latest/code-of-conduct.html). @@ -31,10 +31,10 @@ needs doing: [desktop app](https://github.com/zulip/zulip-electron). * Building out our [Python API and bots](https://github.com/zulip/python-zulip-api) framework. -* [Writing an integration](http://zulip.readthedocs.io/en/latest/integration-guide.html). +* [Writing an integration](http://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html). * Improving our [user](https://chat.zulip.org/help/) or [developer](https://zulip.readthedocs.io/en/latest/) documentation. -* [Reviewing code](http://zulip.readthedocs.io/en/latest/code-reviewing.html) +* [Reviewing code](http://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html) and manually testing pull requests. **Non-code contributions**: Some of the most valuable ways to contribute @@ -43,7 +43,7 @@ don't require touching the codebase at all. We list a few of them below: * [Reporting issues](#reporting-issues), including both feature requests and bug reports. * [Giving feedback](#user-feedback) if you are evaluating or using Zulip. -* [Translating](https://zulip.readthedocs.io/en/latest/translating.html) +* [Translating](https://zulip.readthedocs.io/en/latest/translating/translating.html) Zulip. * [Outreach](#zulip-outreach): Star us on GitHub, upvote us on product comparison sites, or write for the Zulip blog. @@ -55,7 +55,7 @@ contributor. It's long, but don't worry about doing all the steps perfectly; no one gets it right the first time, and there are a lot of people available to help. * First, make an account on the - [Zulip community server](http://zulip.readthedocs.io/en/latest/chat-zulip-org.html), + [Zulip community server](http://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html), paying special attention to the community norms. If you'd like, introduce yourself in [#new members](https://chat.zulip.org/#narrow/stream/new.20members), using @@ -63,12 +63,12 @@ to help. Zulip, and anything that felt confusing/broken as you started using the product. * Read [What makes a great Zulip contributor](#what-makes-a-great-zulip-contributor). -* [Install the development environment](https://zulip.readthedocs.io/en/latest/dev-overview.html), +* [Install the development environment](https://zulip.readthedocs.io/en/latest/development/overview.html), getting help in [#development help](https://chat.zulip.org/#narrow/stream/development.20help) if you run into any troubles. * Read the - [Zulip guide to Git](http://zulip.readthedocs.io/en/latest/git-guide.html) + [Zulip guide to Git](http://zulip.readthedocs.io/en/latest/contributing/git-guide.html) and do the Git tutorial (coming soon) if you are unfamiliar with Git, getting help in [#git help](https://chat.zulip.org/#narrow/stream/git.20help) if you run @@ -162,14 +162,14 @@ best predictors of success: understanding, saying what you've done or tried so far, and including tracebacks or other error messages if appropriate. * Learning and practicing - [Git commit discipline](http://zulip.readthedocs.io/en/latest/version-control.html#commit-discipline). + [Git commit discipline](http://zulip.readthedocs.io/en/latest/contributing/version-control.html#commit-discipline). * Submitting carefully tested code. This generally means checking your work through a combination of automated tests and manually clicking around the UI trying to find bugs in your work. See - [things to look for](http://zulip.readthedocs.io/en/latest/code-reviewing.html#things-to-look-for) + [things to look for](http://zulip.readthedocs.io/en/latest/contributing/code-reviewing.html#things-to-look-for) for additional ideas. * Posting - [screenshots or GIFs](http://zulip.readthedocs.io/en/latest/screenshot-and-gif-software.html) + [screenshots or GIFs](http://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html) for frontend changes. * Being responsive to feedback on pull requests. This means incorporating or responding to all suggested changes, and leaving a note if you won't be @@ -189,12 +189,12 @@ is, the best place to post issues is [#issues](https://chat.zulip.org/#narrow/stream/issues) (or [#mobile](https://chat.zulip.org/#narrow/stream/mobile) or [#electron](https://chat.zulip.org/#narrow/stream/electron)) on the -[Zulip community server](http://zulip.readthedocs.io/en/latest/chat-zulip-org.html). +[Zulip community server](http://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html). This allows us to interactively figure out what is going on, let you know if a similar issue has already been opened, and collect any other information we need. Choose a 2-4 word topic that describes the issue, explain the issue and how to reproduce it if known, your browser/OS if relevant, and a -[screenshot or screenGIF](http://zulip.readthedocs.io/en/latest/screenshot-and-gif-software.html) +[screenshot or screenGIF](http://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html) if appropriate. **Reporting security issues**. Please do not report security issues diff --git a/README.md b/README.md index e5b2892980..8e95880fff 100644 --- a/README.md +++ b/README.md @@ -19,34 +19,34 @@ largest and fastest growing open source group chat project. Click on the appropriate link below. If nothing seems to apply, join us on the -[Zulip community server](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html) +[Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html) and tell us what's up! You might be interested in: * **Contributing code**. Check out our - [guide for new contributors](https://zulip.readthedocs.io/en/latest/contributing.html) + [guide for new contributors](https://zulip.readthedocs.io/en/latest/overview/contributing.html) to get started. Zulip prides itself on maintaining a clean and well-tested codebase, and a stock of hundreds of [beginner-friendly issues](https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). * **Contributing non-code**. - [Report an issue](https://zulip.readthedocs.io/en/latest/contributing.html#reporting-issue), - [translate](https://zulip.readthedocs.io/en/latest/translating.html) Zulip + [Report an issue](https://zulip.readthedocs.io/en/latest/overview/contributing.html#reporting-issue), + [translate](https://zulip.readthedocs.io/en/latest/translating/translating.html) Zulip into your language, - [write](https://zulip.readthedocs.io/en/latest/contributing.html#zulip-outreach) + [write](https://zulip.readthedocs.io/en/latest/overview/contributing.html#zulip-outreach) for the Zulip blog, or - [give us feedback](https://zulip.readthedocs.io/en/latest/contributing.html#user-feedback). We + [give us feedback](https://zulip.readthedocs.io/en/latest/overview/contributing.html#user-feedback). We would love to hear from you, even if you're just trying the product out. * **Supporting Zulip**. Advocate for your organization to use Zulip, write a review in the mobile app stores, or - [upvote Zulip](https://zulip.readthedocs.io/en/latest/contributing.html#zulip-outreach) on + [upvote Zulip](https://zulip.readthedocs.io/en/latest/overview/contributing.html#zulip-outreach) on product comparison sites. * **Checking Zulip out**. The best way to see Zulip in action is to drop by the - [Zulip community server](https://zulip.readthedocs.io/en/latest/chat-zulip-org.html). We + [Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html). We also recommend reading Zulip for [open source](https://zulipchat.com/for/open-source/), Zulip for [companies](https://zulipchat.com/for/companies/), or Zulip for @@ -55,7 +55,7 @@ You might be interested in: * **Running a Zulip server**. Setting up a server takes just a couple of minutes. Zulip runs on Ubuntu 16.04 Xenial and Ubuntu 14.04 Trusty. The installation process is - [documented here](https://zulip.readthedocs.io/en/latest/prod.html). + [documented here](https://zulip.readthedocs.io/en/latest/production/overview.html). Commercial support is available; see for details. @@ -70,7 +70,7 @@ You might be interested in: also participates in [Google Code-In](https://developers.google.com/open-source/gci/). More information is available - [here](https://zulip.readthedocs.io/en/latest/contributing.html#internship-programs). + [here](https://zulip.readthedocs.io/en/latest/overview/contributing.html#internship-programs). You may also be interested in reading our [blog](http://blog.zulip.org/) or following us on [twitter](https://twitter.com/zulip). diff --git a/docs/index.rst b/docs/index.rst index 9d568f0ea3..ea5c818f4e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,24 +10,24 @@ Welcome! Zulip's documentation is split into four parts: - `User documentation `__, for users and administrators of Zulip organizations. -- `Installation documentation `__, +- `Installation documentation `__, for installing and maintaining a self-hosted Zulip installation. - `API documentation `__, for writing integrations or bots using the Zulip API. -- `Contributor documentation `__, +- `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 `__! +`let us know `__! Further information on the Zulip project and its features can be found at `https://www.zulip.org `__. This site contains our installation and contributor documentation. If this is your first time here, you may want to start with -`Production overview `_ or -`Contributing to Zulip `_. +`Production overview `_ or +`Contributing to Zulip `_. Contents: diff --git a/templates/zerver/api/main.html b/templates/zerver/api/main.html index a978a9bb69..1e0664a83e 100644 --- a/templates/zerver/api/main.html +++ b/templates/zerver/api/main.html @@ -21,7 +21,7 @@

Documentation home. The Zulip software, including this documentation, is open source! Learn how - you can contribute here. + you can contribute here.

diff --git a/templates/zerver/api/sidebar.md b/templates/zerver/api/sidebar.md index 7a9b3d62f2..3d9a50519e 100644 --- a/templates/zerver/api/sidebar.md +++ b/templates/zerver/api/sidebar.md @@ -6,14 +6,14 @@ ## Integrations -* [Overview](https://zulip.readthedocs.io/en/latest/integration-guide.html) +* [Overview](https://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html) * [Existing integrations](/integrations) ## Writing webhook integrations -* [Overview](https://zulip.readthedocs.io/en/latest/integration-guide.html#webhook-integrations) -* [Walkthrough](https://zulip.readthedocs.io/en/latest/webhook-walkthrough.html) -* [Documenting integrations](https://zulip.readthedocs.io/en/latest/integration-docs-guide.html) +* [Overview](https://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html#webhook-integrations) +* [Walkthrough](https://zulip.readthedocs.io/en/latest/tutorials/webhook-walkthrough.html) +* [Documenting integrations](https://zulip.readthedocs.io/en/latest/tutorials/integration-docs-guide.html) ## Interactive bots (experimental) diff --git a/templates/zerver/api/writing-bots.md b/templates/zerver/api/writing-bots.md index 2c476be092..259af78f79 100644 --- a/templates/zerver/api/writing-bots.md +++ b/templates/zerver/api/writing-bots.md @@ -6,7 +6,7 @@ third-party service. * **Incoming webhook integrations**, for when you just want notifications from a tool to be sent into Zulip. See the [integrations guide]( - http://zulip.readthedocs.io/en/latest/integration-guide.html?highlight=integrations). + https://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html?highlight=integrations). * **Interactive bots**, for when you want the tool to react to messages in Zulip. @@ -384,7 +384,7 @@ refactor them. *Unit tests for bots make heavy use of mocking. If you want to get comfortable with mocking, mocking strategies, etc. you should check out our [mocking guide]( - https://zulip.readthedocs.io/en/latest/testing-with-django.html#testing-with-mocks).* + https://zulip.readthedocs.io/en/latest/testing/testing-with-django.html#testing-with-mocks).* ### A simple example diff --git a/templates/zerver/help/enable-high-contrast-mode.md b/templates/zerver/help/enable-high-contrast-mode.md index 29082959e6..a85cf0a5f3 100644 --- a/templates/zerver/help/enable-high-contrast-mode.md +++ b/templates/zerver/help/enable-high-contrast-mode.md @@ -2,7 +2,8 @@ Zulip is designed with accessibility in mind. We aim to provide all users with the same quality of experience with our product: you can -read more about our practises in our [documentation](http://zulip.readthedocs.io/en/latest/accessibility.html). +read more about our practises in our +[documentation](http://zulip.readthedocs.io/en/latest/contributing/accessibility.html). By default, some items of the UI (such as date/time stamps, certain buttons, links and unread counts) are intentionally light in order to diff --git a/templates/zerver/help/getting-your-organization-started-with-zulip.md b/templates/zerver/help/getting-your-organization-started-with-zulip.md index 332b27f42e..fe81e83f5c 100644 --- a/templates/zerver/help/getting-your-organization-started-with-zulip.md +++ b/templates/zerver/help/getting-your-organization-started-with-zulip.md @@ -53,7 +53,7 @@ These articles contain great ideas for streams you might want to create in your organization: - [How the Recurse Center uses Zulip](https://www.recurse.com/blog/112-how-rc-uses-zulip) -- [The Zulip community](http://zulip.readthedocs.io/en/latest/chat-zulip-org.html#streams) +- [The Zulip community](http://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html#streams) ## Understanding topics @@ -139,7 +139,7 @@ you use! A few recommendations: GitHub or wiki page with a nice badge. - [Automatically linkify](/help/add-a-custom-linkification-filter) issue numbers and commit IDs. -- [Write custom integrations](https://zulip.readthedocs.io/en/latest/integration-guide.html) +- [Write custom integrations](https://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html) for your community’s unique tools. - If your users primarily speak a language other than English, [set a default language for your organization](/help/change-the-default-language-for-your-organization). @@ -170,4 +170,4 @@ Here are some tips for improving the organization of your Zulip community over t useful. Don’t worry — if you delete a stream, the old stream history is still searchable, and old links will still work. - If you’re running your own Zulip server, - [keep it up to date](http://zulip.readthedocs.io/en/latest/prod-maintain-secure-upgrade.html)! + [keep it up to date](http://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html)!