From 054952a44ab4a31246d80b4bbdddc96c77a07fbb Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Thu, 16 Nov 2017 10:51:44 -0800 Subject: [PATCH] docs: Update links from codebase to point to ReadTheDocs. --- .travis.yml | 2 +- scripts/README.md | 2 +- scripts/lib/install | 4 ++-- static/js/blueslip.js | 2 +- static/js/hashchange.js | 2 +- static/js/pointer.js | 2 +- static/js/reload.js | 2 +- static/js/unread.js | 2 +- static/locale/bg/translations.json | 2 +- static/locale/cs/translations.json | 2 +- static/locale/de/translations.json | 2 +- static/locale/es/translations.json | 2 +- static/locale/fr/translations.json | 2 +- static/locale/hi/translations.json | 2 +- static/locale/hu/translations.json | 2 +- static/locale/id_ID/translations.json | 2 +- static/locale/it/translations.json | 2 +- static/locale/ja/translations.json | 2 +- static/locale/ko/translations.json | 2 +- static/locale/ml/translations.json | 2 +- static/locale/nl/translations.json | 2 +- static/locale/pl/translations.json | 2 +- static/locale/pt/translations.json | 2 +- static/locale/ru/translations.json | 2 +- static/locale/sr/translations.json | 2 +- static/locale/ta/translations.json | 2 +- static/locale/zh_Hans/translations.json | 2 +- static/locale/zh_Hant/translations.json | 2 +- static/swagger/zulip.yaml | 2 +- .../subscription_creation_form.handlebars | 2 +- templates/zerver/accounts_home.html | 2 +- templates/zerver/config_error.html | 8 ++++---- templates/zerver/dev_tools.html | 2 +- templates/zerver/email_log.html | 2 +- templates/zerver/for/open-source.md | 2 +- templates/zerver/help/main.html | 2 +- templates/zerver/integrations/index.html | 2 +- templates/zerver/login.html | 2 +- templates/zerver/plans.html | 2 +- tools/README.md | 2 +- tools/check-capitalization | 3 ++- tools/check-frontend-i18n | 2 +- tools/droplets/README.md | 4 ++-- tools/droplets/create.py | 4 ++-- tools/lib/provision.py | 2 +- tools/test-backend | 2 +- tools/test-migrations | 4 ++-- tools/travis/production-helper | 2 +- tools/travis/setup-production | 2 +- zerver/fixtures/config.generate_data.json | 14 +++++++------- zerver/lib/error_notify.py | 2 +- zerver/lib/events.py | 2 +- zerver/lib/logging_util.py | 2 +- zerver/logging_handlers.py | 2 +- zerver/storage.py | 2 +- zerver/tests/test_events.py | 2 +- zerver/tornado/event_queue.py | 2 +- zerver/views/report.py | 2 +- zerver/worker/queue_processors.py | 2 +- zproject/prod_settings_template.py | 10 +++++----- zproject/settings.py | 6 +++--- 61 files changed, 81 insertions(+), 80 deletions(-) diff --git a/.travis.yml b/.travis.yml index bc68b9dc1e..2e84b2ad3a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,4 @@ -# See https://zulip.readthedocs.io/en/latest/travis.html for +# See https://zulip.readthedocs.io/en/latest/testing/travis.html for # high-level documentation on our Travis CI setup. dist: trusty install: diff --git a/scripts/README.md b/scripts/README.md index 10c1b3f5e4..a0ae14cd5b 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -8,5 +8,5 @@ This directory contains scripts that: development-only scripts live in `tools/`). For more details, see -http://zulip.readthedocs.io/en/latest/directory-structure.html. +https://zulip.readthedocs.io/en/latest/overview/directory-structure.html. diff --git a/scripts/lib/install b/scripts/lib/install index edbab3e7b8..ec4a208bf9 100755 --- a/scripts/lib/install +++ b/scripts/lib/install @@ -107,7 +107,7 @@ if [ "$PUPPET_CLASSES" = "zulip::voyager" ] && { ! [ -e "/etc/ssl/private/zulip. for f in "/etc/ssl/private/zulip.key" "/etc/ssl/certs/zulip.combined-chain.crt"; do [ -e "$f" ] || echo " - $f is missing!" done - echo "See http://zulip.readthedocs.io/en/latest/ssl-certificates.html for help." + echo "See https://zulip.readthedocs.io/en/latest/production/ssl-certificates.html for help." echo echo "Once fixed, just rerun scripts/setup/install; it'll pick up from here!" echo @@ -184,7 +184,7 @@ if [ "$has_nginx" = 0 ]; then echo "Verifying the Zulip nginx configuration failed!" echo echo "This is almost always a problem with your SSL certificates." - echo "See http://zulip.readthedocs.io/en/latest/ssl-certificates.html for help" + echo "See https://zulip.readthedocs.io/en/latest/production/ssl-certificates.html for help" echo echo "Once fixed, just rerun scripts/setup/install; it'll pick up from here!" echo diff --git a/static/js/blueslip.js b/static/js/blueslip.js index 972b022646..65c2c0cc6d 100644 --- a/static/js/blueslip.js +++ b/static/js/blueslip.js @@ -1,4 +1,4 @@ -// System documented in https://zulip.readthedocs.io/en/latest/logging.html +// System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html // This must be included before the first call to $(document).ready // in order to be able to report exceptions that occur during their diff --git a/static/js/hashchange.js b/static/js/hashchange.js index f7c16ba5d7..7abda661de 100644 --- a/static/js/hashchange.js +++ b/static/js/hashchange.js @@ -1,4 +1,4 @@ -// Read https://zulip.readthedocs.io/en/latest/hashchange-system.html +// Read https://zulip.readthedocs.io/en/latest/subsystems/hashchange-system.html var hashchange = (function () { var exports = {}; diff --git a/static/js/pointer.js b/static/js/pointer.js index 2d58ddb85a..7fabcddbb4 100644 --- a/static/js/pointer.js +++ b/static/js/pointer.js @@ -1,4 +1,4 @@ -// See http://zulip.readthedocs.io/en/latest/pointer.html for notes on +// See http://zulip.readthedocs.io/en/latest/subsystems/pointer.html for notes on // how this system is designed. var pointer = (function () { diff --git a/static/js/reload.js b/static/js/reload.js index 9d194293a0..f9c01cf95c 100644 --- a/static/js/reload.js +++ b/static/js/reload.js @@ -1,4 +1,4 @@ -// Read https://zulip.readthedocs.io/en/latest/hashchange-system.html +// Read https://zulip.readthedocs.io/en/latest/subsystems/hashchange-system.html var reload = (function () { var exports = {}; diff --git a/static/js/unread.js b/static/js/unread.js index 457769158f..8fc767dae9 100644 --- a/static/js/unread.js +++ b/static/js/unread.js @@ -1,4 +1,4 @@ -// See http://zulip.readthedocs.io/en/latest/pointer.html for notes on +// See https://zulip.readthedocs.io/en/latest/subsystems/pointer.html for notes on // how this system is designed. var unread = (function () { diff --git a/static/locale/bg/translations.json b/static/locale/bg/translations.json index 88fb424042..86d029c561 100644 --- a/static/locale/bg/translations.json +++ b/static/locale/bg/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "", diff --git a/static/locale/cs/translations.json b/static/locale/cs/translations.json index 84041f9601..dd82b0b057 100644 --- a/static/locale/cs/translations.json +++ b/static/locale/cs/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Filtrovat skupiny", "Filter users": "Filtrovat uživatele", "First time? Read our guidelines for creating and naming streams.": "Poprvé? Přečtěte si naše pokyny, jak tvořit a pojmenovávat skupiny.", - "For more information on public/private streams, check out our docs.": "Další údaje k veřejným/soukromým skupinám zjistíte v našich dokumentech.", + "For more information on public/private streams, check out our docs.": "Další údaje k veřejným/soukromým skupinám zjistíte v našich dokumentech.", "Forgotten it?": "Zapomněl jste?", "Formatting": "Formátování", "Full name": "Plný název", diff --git a/static/locale/de/translations.json b/static/locale/de/translations.json index a1a3c66c8f..d5330ebef0 100644 --- a/static/locale/de/translations.json +++ b/static/locale/de/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Streams filtern", "Filter users": "Benutzer filtern", "First time? Read our guidelines for creating and naming streams.": "Zum ersten Mal hier? Lies unsere Richtlinien zur Erstellung und Benennung von Kanälen.", - "For more information on public/private streams, check out our docs.": "Für weitere Informationen zu öffentlichen/privaten Streams, schau dir unsere Dokumentation an.", + "For more information on public/private streams, check out our docs.": "Für weitere Informationen zu öffentlichen/privaten Streams, schau dir unsere Dokumentation an.", "Forgotten it?": "Passwort vergessen?", "Formatting": "Formatierung", "Full name": "Vollständiger Name", diff --git a/static/locale/es/translations.json b/static/locale/es/translations.json index 12242be2d5..22aac290f9 100644 --- a/static/locale/es/translations.json +++ b/static/locale/es/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Filtrar canales", "Filter users": "Filtrar usuarios", "First time? Read our guidelines for creating and naming streams.": "¿Es tu primera vez aquí? Lee nuestras pautas para crear y ponerle nombre a los canales.", - "For more information on public/private streams, check out our docs.": "Para más información sobre canales públicos/privados, echa un vistazo a nuestra documentación.", + "For more information on public/private streams, check out our docs.": "Para más información sobre canales públicos/privados, echa un vistazo a nuestra documentación.", "Forgotten it?": "¿Te has olvidado?", "Formatting": "Formato", "Full name": "Nombre completo", diff --git a/static/locale/fr/translations.json b/static/locale/fr/translations.json index e1c7841c12..5cf648febb 100644 --- a/static/locale/fr/translations.json +++ b/static/locale/fr/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Filtrer les canaux", "Filter users": "Filtrer les utilisateurs", "First time? Read our guidelines for creating and naming streams.": "Première fois? Lisez nos instructions pour créer et nommer des canaux.", - "For more information on public/private streams, check out our docs.": "Pour plus d'information sur les canaux publics/privés, visiter notre documentation.", + "For more information on public/private streams, check out our docs.": "Pour plus d'information sur les canaux publics/privés, visiter notre documentation.", "Forgotten it?": "Oublier?", "Formatting": "Formater", "Full name": "Nom complet", diff --git a/static/locale/hi/translations.json b/static/locale/hi/translations.json index a4332b25f7..72a3f0ba94 100644 --- a/static/locale/hi/translations.json +++ b/static/locale/hi/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "", diff --git a/static/locale/hu/translations.json b/static/locale/hu/translations.json index adf77349eb..606b9ee48f 100644 --- a/static/locale/hu/translations.json +++ b/static/locale/hu/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "Formázás", "Full name": "Teljes név", diff --git a/static/locale/id_ID/translations.json b/static/locale/id_ID/translations.json index 941df8c408..8e49e426e8 100644 --- a/static/locale/id_ID/translations.json +++ b/static/locale/id_ID/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Saring stream", "Filter users": "Saring pengguna", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "Lupa?", "Formatting": "Format", "Full name": "Nama lengkap", diff --git a/static/locale/it/translations.json b/static/locale/it/translations.json index 97a184603a..ec543ff988 100644 --- a/static/locale/it/translations.json +++ b/static/locale/it/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "", diff --git a/static/locale/ja/translations.json b/static/locale/ja/translations.json index 559f2e4ab6..92eab1984d 100644 --- a/static/locale/ja/translations.json +++ b/static/locale/ja/translations.json @@ -191,7 +191,7 @@ "Filter streams": "ストリームをフィルター", "Filter users": "ユーザーを絞り込み", "First time? Read our guidelines for creating and naming streams.": "初めてですか？ストリームを作成するためにガイドラインを読んでみてください。", - "For more information on public/private streams, check out our docs.": "公開/プライベートのストリームの詳細については ドキュメントを確認してください。", + "For more information on public/private streams, check out our docs.": "公開/プライベートのストリームの詳細については ドキュメントを確認してください。", "Forgotten it?": "忘れましたか？", "Formatting": "フォーマット", "Full name": "姓名", diff --git a/static/locale/ko/translations.json b/static/locale/ko/translations.json index ca16ee4311..c01b7a032a 100644 --- a/static/locale/ko/translations.json +++ b/static/locale/ko/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "", diff --git a/static/locale/ml/translations.json b/static/locale/ml/translations.json index acd3a83cb5..8565c57b8e 100644 --- a/static/locale/ml/translations.json +++ b/static/locale/ml/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "അതു മറന്നുപോയോ?", "Formatting": "", "Full name": "മുഴുവൻ പേര്", diff --git a/static/locale/nl/translations.json b/static/locale/nl/translations.json index 4609c0f482..b7cc1ae8f5 100644 --- a/static/locale/nl/translations.json +++ b/static/locale/nl/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Filter kanalen", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "Vergeten?", "Formatting": "Opmaken", "Full name": "Volledige naam", diff --git a/static/locale/pl/translations.json b/static/locale/pl/translations.json index 420856ef5b..fdc31e10ad 100644 --- a/static/locale/pl/translations.json +++ b/static/locale/pl/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Filtruj kanały", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "Nie pamiętasz?", "Formatting": "Formatowanie", "Full name": "Imię i nazwisko", diff --git a/static/locale/pt/translations.json b/static/locale/pt/translations.json index 120dec943b..bfd02ada9f 100644 --- a/static/locale/pt/translations.json +++ b/static/locale/pt/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "Formata\u00e7\u00e3o", "Full name": "Nome completo", diff --git a/static/locale/ru/translations.json b/static/locale/ru/translations.json index 8c85bd9055..3afc39869e 100644 --- a/static/locale/ru/translations.json +++ b/static/locale/ru/translations.json @@ -191,7 +191,7 @@ "Filter streams": "Отфильтровать каналы", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "Забыли?", "Formatting": "Форматирование текста", "Full name": "Полное имя", diff --git a/static/locale/sr/translations.json b/static/locale/sr/translations.json index 1b9aa5331a..4f07724d07 100644 --- a/static/locale/sr/translations.json +++ b/static/locale/sr/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "", diff --git a/static/locale/ta/translations.json b/static/locale/ta/translations.json index a00d48fa7c..261b07616b 100644 --- a/static/locale/ta/translations.json +++ b/static/locale/ta/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "முழு பெயர்", diff --git a/static/locale/zh_Hans/translations.json b/static/locale/zh_Hans/translations.json index 9c5e67b07f..6585c7a162 100644 --- a/static/locale/zh_Hans/translations.json +++ b/static/locale/zh_Hans/translations.json @@ -191,7 +191,7 @@ "Filter streams": "过滤频道", "Filter users": "过滤用户", "First time? Read our guidelines for creating and naming streams.": "第一次？请阅读 指南 来创建和命名流。", - "For more information on public/private streams, check out our docs.": "查看更多有关于公开频道和隐私频道的信息，请点击这里查看我们的文档", + "For more information on public/private streams, check out our docs.": "查看更多有关于公开频道和隐私频道的信息，请点击这里查看我们的文档", "Forgotten it?": "忘记了？", "Formatting": "格式化", "Full name": "名称", diff --git a/static/locale/zh_Hant/translations.json b/static/locale/zh_Hant/translations.json index 69fdb892ee..38649a8aba 100644 --- a/static/locale/zh_Hant/translations.json +++ b/static/locale/zh_Hant/translations.json @@ -191,7 +191,7 @@ "Filter streams": "", "Filter users": "", "First time? Read our guidelines for creating and naming streams.": "", - "For more information on public/private streams, check out our docs.": "", + "For more information on public/private streams, check out our docs.": "", "Forgotten it?": "", "Formatting": "", "Full name": "", diff --git a/static/swagger/zulip.yaml b/static/swagger/zulip.yaml index 2ff0356081..21ad3f9e6a 100644 --- a/static/swagger/zulip.yaml +++ b/static/swagger/zulip.yaml @@ -5,7 +5,7 @@ # # Our own documentation lives at # -# https://zulip.readthedocs.io/en/latest/swagger-api-docs.html +# https://zulip.readthedocs.io/en/latest/subsystems/swagger-api-docs.html # # Basic Swagger UI info swagger: '2.0' diff --git a/static/templates/subscription_creation_form.handlebars b/static/templates/subscription_creation_form.handlebars index c61c812cfe..8fc53ee5af 100644 --- a/static/templates/subscription_creation_form.handlebars +++ b/static/templates/subscription_creation_form.handlebars @@ -24,7 +24,7 @@
{{#tr this}} - For more information on public/private streams, check out our docs. + For more information on public/private streams, check out our docs. {{/tr}}

-

You can find docs on testing Google & GitHub authentication over here.

+

You can find docs on testing Google & GitHub authentication over here.

{% endblock %} diff --git a/templates/zerver/email_log.html b/templates/zerver/email_log.html index b0c92548ac..ab0baaeeb1 100644 --- a/templates/zerver/email_log.html +++ b/templates/zerver/email_log.html @@ -48,7 +48,7 @@
You must setup SMTP as described - + here first before enabling this.
diff --git a/templates/zerver/for/open-source.md b/templates/zerver/for/open-source.md index 0f1d733e76..75bfb01878 100644 --- a/templates/zerver/for/open-source.md +++ b/templates/zerver/for/open-source.md @@ -74,7 +74,7 @@ issue its own place for discussion. Don’t like something? You can [open an issue](https://github.com/zulip/zulip/issues), -[submit a patch](http://zulip.readthedocs.io/en/latest/dev-overview.html), +[submit a patch](http://zulip.readthedocs.io/en/latest/development/overview.html), [fork the project](https://github.com/zulip/zulip), or chat with us directly at [chat.zulip.org](https://chat.zulip.org). All code, including the [desktop](https://github.com/zulip/zulip-electron) and diff --git a/templates/zerver/help/main.html b/templates/zerver/help/main.html index 0d45d2259f..8eefc416c8 100644 --- a/templates/zerver/help/main.html +++ b/templates/zerver/help/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/integrations/index.html b/templates/zerver/integrations/index.html index 56d86b3562..cfa4f86f27 100644 --- a/templates/zerver/integrations/index.html +++ b/templates/zerver/integrations/index.html @@ -108,7 +108,7 @@ {% endif %} {% endfor %} - +
diff --git a/templates/zerver/plans.html b/templates/zerver/plans.html index c957023e62..e2253f69c9 100644 --- a/templates/zerver/plans.html +++ b/templates/zerver/plans.html @@ -44,7 +44,7 @@
Free and open source forever!
- + diff --git a/tools/README.md b/tools/README.md index fec9bafce4..fc0b7d74e4 100644 --- a/tools/README.md +++ b/tools/README.md @@ -4,5 +4,5 @@ Note that tools that are also useful in production belong in `scripts/` or should be Django management commands. For more details, see -http://zulip.readthedocs.io/en/latest/directory-structure.html. +http://zulip.readthedocs.io/en/latest/overview/directory-structure.html. diff --git a/tools/check-capitalization b/tools/check-capitalization index 504837aa4f..91b0dcb970 100755 --- a/tools/check-capitalization +++ b/tools/check-capitalization @@ -57,7 +57,8 @@ if __name__ == '__main__': if frontend_errors or backend_errors: # Point the user to the documentation on what the policy is. - print(WARNING + "See https://zulip.readthedocs.io/en/latest/translating.html#capitalization" + ENDC) + docs_url = "https://zulip.readthedocs.io/en/latest/translating/translating.html#capitalization" + print(WARNING + "See " + docs_url + ENDC) print(FAIL + "Failed!" + ENDC) sys.exit(1) else: diff --git a/tools/check-frontend-i18n b/tools/check-frontend-i18n index acf3a4d174..c27102bc25 100755 --- a/tools/check-frontend-i18n +++ b/tools/check-frontend-i18n @@ -42,7 +42,7 @@ if __name__ == '__main__': print('\n'.join(found)) print(WARNING + - "See http://zulip.readthedocs.io/en/latest/translating.html#frontend-translations " + "See http://zulip.readthedocs.io/en/latest/translating/translating.html#frontend-translations " "on how you can insert variables in the frontend translatable " "strings." + ENDC) diff --git a/tools/droplets/README.md b/tools/droplets/README.md index 006da537dd..2d06c40a61 100644 --- a/tools/droplets/README.md +++ b/tools/droplets/README.md @@ -97,9 +97,9 @@ Your remote Zulip dev server has been created! at http://.zulipdev.org:9991. See [Developing -remotely](http://zulip.readthedocs.io/en/latest/dev-remote.html) for tips on +remotely](http://zulip.readthedocs.io/en/latest/development/remote.html) for tips on using the remote dev instance and [Git & GitHub -Guide](http://zulip.readthedocs.io/en/latest/git-guide.html) to learn how to +Guide](http://zulip.readthedocs.io/en/latest/contributing/git-guide.html) to learn how to use Git with Zulip. ``` diff --git a/tools/droplets/create.py b/tools/droplets/create.py index 4905f5e608..f8e93b77b1 100644 --- a/tools/droplets/create.py +++ b/tools/droplets/create.py @@ -198,9 +198,9 @@ Your remote Zulip dev server has been created! http://{0}.zulipdev.org:9991. """.format(username)) - print("See [Developing remotely](http://zulip.readthedocs.io/en/latest/dev-remote.html) " + print("See [Developing remotely](http://zulip.readthedocs.io/en/latest/development/remote.html) " "for tips on using the remote dev instance and " - "[Git & GitHub Guide](http://zulip.readthedocs.io/en/latest/git-guide.html) to learn " + "[Git & GitHub Guide](http://zulip.readthedocs.io/en/latest/contributing/git-guide.html) to learn " "how to use Git with Zulip.\n") print("Note that this droplet will automatically be deleted after a month of inactivity. " "If you are leaving Zulip for more than a few weeks, we recommend pushing all of your " diff --git a/tools/lib/provision.py b/tools/lib/provision.py index d37f325c9a..784bc494c1 100755 --- a/tools/lib/provision.py +++ b/tools/lib/provision.py @@ -80,7 +80,7 @@ try: except OSError as err: print("Error: Unable to create symlinks. Make sure you have permission to create symbolic links.") print("See this page for more information:") - print(" http://zulip.readthedocs.io/en/latest/dev-env-first-time-contributors.html#os-symlink-error") + print(" http://zulip.readthedocs.io/en/latest/development/setup-vagrant.html#os-symlink-error") sys.exit(1) if platform.architecture()[0] == '64bit': diff --git a/tools/test-backend b/tools/test-backend index b450863a5b..62a0e65c98 100755 --- a/tools/test-backend +++ b/tools/test-backend @@ -163,7 +163,7 @@ def block_internet(): # type: (*Any, **Any) -> None raise Exception("Outgoing network requests are not allowed in the Zulip tests. " "More details and advice are available here:" - "https://zulip.readthedocs.io/en/latest/testing.html#internet-access-inside-test-suits") + "https://zulip.readthedocs.io/en/latest/testing/testing.html#internet-access-inside-test-suites") httplib2.Http.request = internet_guard requests.request = internet_guard diff --git a/tools/test-migrations b/tools/test-migrations index 7de6501f75..11b00469e1 100755 --- a/tools/test-migrations +++ b/tools/test-migrations @@ -11,7 +11,7 @@ if [ "$new_auto_named_migrations" != "" ]; then echo echo "$new_auto_named_migrations" | sed 's/\[[x ]\] / /' echo - echo 'See https://zulip.readthedocs.io/en/latest/schema-migrations.html for advice.' + echo 'See https://zulip.readthedocs.io/en/latest/subsystems/schema-migrations.html for advice.' echo exit 1 fi @@ -19,7 +19,7 @@ fi if ! ./manage.py makemigrations --check --dry-run; then echo echo 'ERROR: Migrations are not consistent with models! Fix with `./tools/renumber-migrations`.' - echo 'See http://zulip.readthedocs.io/en/latest/schema-migrations.html for details.' + echo 'See https://zulip.readthedocs.io/en/latest/subsystems/schema-migrations.html for details.' echo exit 1 else diff --git a/tools/travis/production-helper b/tools/travis/production-helper index 8188a293a2..6c5a28c5dc 100755 --- a/tools/travis/production-helper +++ b/tools/travis/production-helper @@ -100,7 +100,7 @@ if ! diff /tmp/expected_queue_processors.txt /tmp/running_queue_processors.txt > set +x echo "FAILURE: Runnable queue processors declared in zerver/worker/queue_processors.py " echo "do not match those in puppet/manifests/zulip/base.pp" - echo "See http://zulip.readthedocs.io/en/latest/queuing.html for details." + echo "See https://zulip.readthedocs.io/en/latest/subsystems/queuing.html for details." echo diff -ur /tmp/expected_queue_processors.txt /tmp/running_queue_processors.txt exit 1 diff --git a/tools/travis/setup-production b/tools/travis/setup-production index c1d9e2899a..92d01d4520 100755 --- a/tools/travis/setup-production +++ b/tools/travis/setup-production @@ -8,7 +8,7 @@ # remove some and reconfigure others to make things run smoothly and # quickly. # -# More description in https://zulip.readthedocs.io/en/latest/events-system.html. +# More description in https://zulip.readthedocs.io/en/latest/testing/travis.html. set -e set -x diff --git a/zerver/fixtures/config.generate_data.json b/zerver/fixtures/config.generate_data.json index 47bb3770fc..228630d0d9 100644 --- a/zerver/fixtures/config.generate_data.json +++ b/zerver/fixtures/config.generate_data.json @@ -18,13 +18,13 @@ "emoji": [":thumbs_up:", ":thumbs_down:", ":shirt:", ":zulip:", ":tada:", ":earth_asia:", ":cop:", ":8ball:", ":boat:", ":egg:", ":heartpulse:", ":moon_ceremony:", ":cupid:", ":mag:"], "links": - ["http://zulip.readthedocs.io/en/latest/emoji.html", - "http://zulip.readthedocs.io/en/latest/full-text-search.html", - "http://zulip.readthedocs.io/en/latest/analytics.html", - "http://zulip.readthedocs.io/en/latest/translating.html", - "http://zulip.readthedocs.io/en/latest/client.html", - "http://zulip.readthedocs.io/en/latest/logging.html", - "http://zulip.readthedocs.io/en/latest/release-checklist.html"], + ["http://zulip.readthedocs.io/en/latest/subsystems/emoji.html", + "http://zulip.readthedocs.io/en/latest/subsystems/full-text-search.html", + "http://zulip.readthedocs.io/en/latest/subsystems/analytics.html", + "http://zulip.readthedocs.io/en/latest/translating/translating.html", + "http://zulip.readthedocs.io/en/latest/subsystems/client.html", + "http://zulip.readthedocs.io/en/latest/subsystems/logging.html", + "http://zulip.readthedocs.io/en/latest/subsystems/release-checklist.html"], "inline-code": [ "`(reduce (fn [m [k v]] (assoc m v k)) {} {:b 2 :a 1 :c 3})`" , "`select id, first-name, last-name from users where active = 1;`", diff --git a/zerver/lib/error_notify.py b/zerver/lib/error_notify.py index 5334612b98..b30fdb7236 100644 --- a/zerver/lib/error_notify.py +++ b/zerver/lib/error_notify.py @@ -1,4 +1,4 @@ -# System documented in https://zulip.readthedocs.io/en/latest/logging.html +# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html import logging diff --git a/zerver/lib/events.py b/zerver/lib/events.py index bd24152ecc..32461c5ae3 100644 --- a/zerver/lib/events.py +++ b/zerver/lib/events.py @@ -1,4 +1,4 @@ -# See http://zulip.readthedocs.io/en/latest/events-system.html for +# See https://zulip.readthedocs.io/en/latest/subsystems/events-system.html for # high-level documentation on how this system works. import copy diff --git a/zerver/lib/logging_util.py b/zerver/lib/logging_util.py index 4ad1c81d9c..5d03ed3c34 100644 --- a/zerver/lib/logging_util.py +++ b/zerver/lib/logging_util.py @@ -1,4 +1,4 @@ -# System documented in https://zulip.readthedocs.io/en/latest/logging.html +# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html from django.utils.timezone import now as timezone_now from django.utils.timezone import utc as timezone_utc diff --git a/zerver/logging_handlers.py b/zerver/logging_handlers.py index e459846bf2..f8bd16b46a 100644 --- a/zerver/logging_handlers.py +++ b/zerver/logging_handlers.py @@ -1,4 +1,4 @@ -# System documented in https://zulip.readthedocs.io/en/latest/logging.html +# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html import logging import platform diff --git a/zerver/storage.py b/zerver/storage.py index e26439993d..e85d172a0d 100644 --- a/zerver/storage.py +++ b/zerver/storage.py @@ -1,4 +1,4 @@ -# Useful reading is https://zulip.readthedocs.io/en/latest/front-end-build-process.html +# Useful reading is https://zulip.readthedocs.io/en/latest/subsystems/front-end-build-process.html import os import shutil diff --git a/zerver/tests/test_events.py b/zerver/tests/test_events.py index 427214e5b6..22de321c45 100644 --- a/zerver/tests/test_events.py +++ b/zerver/tests/test_events.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# See http://zulip.readthedocs.io/en/latest/events-system.html for +# See http://zulip.readthedocs.io/en/latest/subsystems/events-system.html for # high-level documentation on how this system works. from typing import Any, Callable, Dict, List, Optional, Set, Text, Tuple, Union import os diff --git a/zerver/tornado/event_queue.py b/zerver/tornado/event_queue.py index ddc4d8ba1b..d3984e5de2 100644 --- a/zerver/tornado/event_queue.py +++ b/zerver/tornado/event_queue.py @@ -1,4 +1,4 @@ -# See http://zulip.readthedocs.io/en/latest/events-system.html for +# See https://zulip.readthedocs.io/en/latest/subsystems/events-system.html for # high-level documentation on how this system works. from typing import cast, AbstractSet, Any, Callable, Dict, List, \ Mapping, MutableMapping, Optional, Iterable, Sequence, Set, Text, Union diff --git a/zerver/views/report.py b/zerver/views/report.py index 928153749f..ac58db050d 100644 --- a/zerver/views/report.py +++ b/zerver/views/report.py @@ -1,4 +1,4 @@ -# System documented in https://zulip.readthedocs.io/en/latest/logging.html +# System documented in https://zulip.readthedocs.io/en/latest/subsystems/logging.html from typing import Any, Dict, Optional, Text, Union diff --git a/zerver/worker/queue_processors.py b/zerver/worker/queue_processors.py index 9ddf77180e..1eebffbd2d 100644 --- a/zerver/worker/queue_processors.py +++ b/zerver/worker/queue_processors.py @@ -1,4 +1,4 @@ -# Documented in http://zulip.readthedocs.io/en/latest/queuing.html +# Documented in http://zulip.readthedocs.io/en/latest/subsystems/queuing.html from typing import Any, Callable, Dict, List, Mapping, Optional, cast import signal diff --git a/zproject/prod_settings_template.py b/zproject/prod_settings_template.py index 9e0af2846d..44cfac6dda 100644 --- a/zproject/prod_settings_template.py +++ b/zproject/prod_settings_template.py @@ -2,7 +2,7 @@ from typing import Optional # Zulip Settings intended to be set by a system administrator. # -# See http://zulip.readthedocs.io/en/latest/settings.html for +# See https://zulip.readthedocs.io/en/latest/subsystems/settings.html for # detailed technical documentation on the Zulip settings system. # ### MANDATORY SETTINGS @@ -35,7 +35,7 @@ ZULIP_ADMINISTRATOR = 'zulip-admin@example.com' # SMTP server already, we recommend services intended for developers # such as Mailgun. Detailed documentation is available at: # -# https://zulip.readthedocs.io/en/latest/prod-email.html +# https://zulip.readthedocs.io/en/latest/production/email.html # # To configure SMTP, you will need to complete the following steps: # @@ -87,7 +87,7 @@ EMAIL_USE_TLS = True ### AUTHENTICATION SETTINGS # # Enable at least one of the following authentication backends. -# See http://zulip.readthedocs.io/en/latest/prod-authentication-methods.html +# See https://zulip.readthedocs.io/en/latest/production/authentication-methods.html # for documentation on our authentication backends. # # The install process requires EmailAuthBackend (the default) to be @@ -154,7 +154,7 @@ SSO_APPEND_DOMAIN = None # type: Optional[str] # Support for mobile push notifications. Setting controls whether # push notifications will be forwarded through a Zulip push # notification bouncer server to the mobile apps. See -# https://zulip.readthedocs.io/en/latest/prod-mobile-push-notifications.html +# https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html # for information on how to sign up for and configure this. #PUSH_NOTIFICATION_BOUNCER_URL = 'https://push.zulipchat.com' @@ -171,7 +171,7 @@ SESSION_EXPIRE_AT_BROWSER_CLOSE = False SESSION_COOKIE_AGE = 60 * 60 * 24 * 7 * 2 # 2 weeks # Password strength requirements; learn about configuration at -# http://zulip.readthedocs.io/en/latest/security-model.html. +# https://zulip.readthedocs.io/en/latest/production/security-model.html. # PASSWORD_MIN_LENGTH = 6 # PASSWORD_MIN_GUESSES = 10000 diff --git a/zproject/settings.py b/zproject/settings.py index 3e8f95e607..560e130b5e 100644 --- a/zproject/settings.py +++ b/zproject/settings.py @@ -7,7 +7,7 @@ # * settings.py imports prod_settings.py, and any site-specific configuration # belongs there. The template for prod_settings.py is prod_settings_template.py # -# See http://zulip.readthedocs.io/en/latest/settings.html for more information +# See https://zulip.readthedocs.io/en/latest/subsystems/settings.html for more information # ######################################################################## from copy import deepcopy @@ -762,7 +762,7 @@ STATIC_HEADER_FILE = 'zerver/static_header.txt' # static files. # # Useful reading on how this works is in -# https://zulip.readthedocs.io/en/latest/front-end-build-process.html +# https://zulip.readthedocs.io/en/latest/subsystems/front-end-build-process.html PIPELINE = { 'PIPELINE_ENABLED': PIPELINE_ENABLED, @@ -898,7 +898,7 @@ PIPELINE = { } # Useful reading on how this works is in -# https://zulip.readthedocs.io/en/latest/front-end-build-process.html +# https://zulip.readthedocs.io/en/latest/subsystems/front-end-build-process.html JS_SPECS = { 'app': { 'source_filenames': [