docs: Update links to ReadTheDocs to always use https.

This is better security practice.

We also add a lint rule to enforce this for the future.
This commit is contained in:
Tim Abbott 2017-11-16 10:54:24 -08:00
parent 054952a44a
commit 638eb7a8e4
21 changed files with 56 additions and 53 deletions

View File

@ -9,9 +9,9 @@ The
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/contributing/chat-zulip-org.html#community-norms)
[community norms](https://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).
[code of conduct](https://zulip.readthedocs.io/en/latest/code-of-conduct.html).
You can subscribe to zulip-devel@googlegroups.com for a lower traffic (~1
email/month) way to hear about things like mentorship opportunities with Google
@ -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/tutorials/integration-guide.html).
* [Writing an integration](https://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/contributing/code-reviewing.html)
* [Reviewing code](https://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
@ -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/contributing/chat-zulip-org.html),
[Zulip community server](https://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
@ -68,7 +68,7 @@ to help.
[#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/contributing/git-guide.html)
[Zulip guide to Git](https://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/contributing/version-control.html#commit-discipline).
[Git commit discipline](https://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/contributing/code-reviewing.html#things-to-look-for)
[things to look for](https://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/tutorials/screenshot-and-gif-software.html)
[screenshots or GIFs](https://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/contributing/chat-zulip-org.html).
[Zulip community server](https://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/tutorials/screenshot-and-gif-software.html)
[screenshot or screenGIF](https://zulip.readthedocs.io/en/latest/tutorials/screenshot-and-gif-software.html)
if appropriate.
**Reporting security issues**. Please do not report security issues

View File

@ -11,7 +11,7 @@ largest and fastest growing open source group chat project.
[![Build Status](https://travis-ci.org/zulip/zulip.svg?branch=master)](https://travis-ci.org/zulip/zulip)
[![Coverage Status](https://img.shields.io/codecov/c/github/zulip/zulip.svg)](https://codecov.io/gh/zulip/zulip)
[![Mypy coverage](https://img.shields.io/badge/mypy-100%25-green.svg)](http://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/)
[![docs](https://readthedocs.org/projects/zulip/badge/?version=latest)](http://zulip.readthedocs.io/en/latest/)
[![docs](https://readthedocs.org/projects/zulip/badge/?version=latest)](https://zulip.readthedocs.io/en/latest/)
[![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org)
[![Twitter](https://img.shields.io/badge/twitter-@zulip-blue.svg?style=flat)](http://twitter.com/zulip)

View File

@ -1,4 +1,4 @@
// See http://zulip.readthedocs.io/en/latest/subsystems/pointer.html for notes on
// See https://zulip.readthedocs.io/en/latest/subsystems/pointer.html for notes on
// how this system is designed.
var pointer = (function () {

View File

@ -24,7 +24,7 @@
</div>
<div class="stream-creation-info">
{{#tr this}}
For more information on public/private streams, check out our <a href="http://zulip.readthedocs.io/en/latest/subsystems/security-model.html?highlight=private%20stream#messages-and-history">docs</a>.
For more information on public/private streams, check out our <a href="https://zulip.readthedocs.io/en/latest/subsystems/security-model.html?highlight=private%20stream#messages-and-history">docs</a>.
{{/tr}}
</div>
<ul class="grey-box">

View File

@ -45,7 +45,7 @@ $(function () {
<p>
See
the <a href="http://zulip.readthedocs.io/en/latest/production/install.html#step-3-configure-zulip">Zulip
the <a href="https://zulip.readthedocs.io/en/latest/production/install.html#step-3-configure-zulip">Zulip
authentication documentation</a> to learn how to
configure authentication backends.
</p>

View File

@ -56,13 +56,13 @@
{% if development_environment %}
<p>
For more information, have a look at
the <a href="http://zulip.readthedocs.io/en/latest/subsystems/settings.html#testing-google-github-authentication">authentication
the <a href="https://zulip.readthedocs.io/en/latest/subsystems/settings.html#testing-google-github-authentication">authentication
setup guide</a> for the development environment.
</p>
{% else %}
<p>
For more information, have a look at
our <a href="http://zulip.readthedocs.io/en/latest/production/authentication-methods.html">authentication
our <a href="https://zulip.readthedocs.io/en/latest/production/authentication-methods.html">authentication
setup guide</a> and the comments in <code>{{ settings_comments_path }}</code>.
</p>
{% endif %}

View File

@ -74,7 +74,7 @@ issue its own place for discussion.
Dont like something? You can
[open an issue](https://github.com/zulip/zulip/issues),
[submit a patch](http://zulip.readthedocs.io/en/latest/development/overview.html),
[submit a patch](https://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

View File

@ -3,7 +3,7 @@
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/contributing/accessibility.html).
[documentation](https://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

View File

@ -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/contributing/chat-zulip-org.html#streams)
- [The Zulip community](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html#streams)
## Understanding topics
@ -170,4 +170,4 @@ Here are some tips for improving the organization of your Zulip community over t
useful. Dont worry — if you delete a stream, the old stream history
is still searchable, and old links will still work.
- If youre running your own Zulip server,
[keep it up to date](http://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html)!
[keep it up to date](https://zulip.readthedocs.io/en/latest/production/maintain-secure-upgrade.html)!

View File

@ -3,4 +3,4 @@
For information on how to run a bot on a running Zulip server, please
go through our [How to run a bot][1] tutorial.
[1]: http://zulip.readthedocs.io/en/latest/bots-guide.html#how-to-run-a-bot
[1]: https://zulip.readthedocs.io/en/latest/bots-guide.html#how-to-run-a-bot

View File

@ -72,7 +72,7 @@
features</a> can be found on
the <a href="https://www.zulip.org">Zulip open source project's
website</a> and
the <a href="http://zulip.readthedocs.io/en/latest/">Zulip
the <a href="https://zulip.readthedocs.io/en/latest/">Zulip
documentation</a>.
</p>
@ -85,7 +85,7 @@
Zulip community welcomes new contributors from any background. The
project has an easy to install development environment, an extensive
test suite,
and <a href="http://zulip.readthedocs.io/en/latest/">over 100,000
and <a href="https://zulip.readthedocs.io/en/latest/">over 100,000
words of developer documentation</a> to make it easy for new
contributors to contribute effectively to the project.
</p>

View File

@ -108,7 +108,7 @@
</a>
{% endif %}
{% endfor %}
<a href="http://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html">
<a href="https://zulip.readthedocs.io/en/latest/tutorials/integration-guide.html">
<div class="integration-lozenge integration-create-your-own">
<div class="integration-logo">
<i class="icon-vector-plus"></i>

View File

@ -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/overview/directory-structure.html.
https://zulip.readthedocs.io/en/latest/overview/directory-structure.html.

View File

@ -37,16 +37,16 @@ if __name__ == '__main__':
data = json.load(f)
found = find_handlebars(list(data.keys()))
if found:
print(WARNING + "Translation strings contain handlebars:" + ENDC)
print('\n'.join(found))
print(WARNING +
"See http://zulip.readthedocs.io/en/latest/translating/translating.html#frontend-translations "
"on how you can insert variables in the frontend translatable "
"strings." +
ENDC)
print(FAIL + "Failed!" + ENDC)
sys.exit(1)
else:
if not found:
sys.exit(0)
print(WARNING + "Translation strings contain handlebars:" + ENDC)
print('\n'.join(found))
print(WARNING +
"See https://zulip.readthedocs.io/en/latest/translating/translating.html#frontend-translations "
"on how you can insert variables in the frontend translatable "
"strings." +
ENDC)
print(FAIL + "Failed!" + ENDC)
sys.exit(1)

View File

@ -97,9 +97,9 @@ Your remote Zulip dev server has been created!
at http://<username>.zulipdev.org:9991.
See [Developing
remotely](http://zulip.readthedocs.io/en/latest/development/remote.html) for tips on
remotely](https://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/contributing/git-guide.html) to learn how to
Guide](https://zulip.readthedocs.io/en/latest/contributing/git-guide.html) to learn how to
use Git with Zulip.
```

View File

@ -198,10 +198,10 @@ 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/development/remote.html) "
print("See [Developing remotely](https://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/contributing/git-guide.html) to learn "
"how to use Git with Zulip.\n")
"[Git & GitHub Guide](https://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 "
"active branches to GitHub.")

View File

@ -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/development/setup-vagrant.html#os-symlink-error")
print(" https://zulip.readthedocs.io/en/latest/development/setup-vagrant.html#os-symlink-error")
sys.exit(1)
if platform.architecture()[0] == '64bit':

View File

@ -139,6 +139,9 @@ def build_custom_checkers(by_lang):
whitespace_rules = [
# This linter should be first since bash_rules depends on it.
trailing_whitespace_rule,
{'pattern': 'http://zulip.readthedocs.io',
'description': 'Use HTTPS when linking to ReadTheDocs',
},
{'pattern': '\t',
'strip': '\n',
'exclude': set(['tools/travis/success-http-headers.txt']),

View File

@ -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/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"],
["https://zulip.readthedocs.io/en/latest/subsystems/emoji.html",
"https://zulip.readthedocs.io/en/latest/subsystems/full-text-search.html",
"https://zulip.readthedocs.io/en/latest/subsystems/analytics.html",
"https://zulip.readthedocs.io/en/latest/translating/translating.html",
"https://zulip.readthedocs.io/en/latest/subsystems/client.html",
"https://zulip.readthedocs.io/en/latest/subsystems/logging.html",
"https://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;`",

View File

@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
# See http://zulip.readthedocs.io/en/latest/subsystems/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 Any, Callable, Dict, List, Optional, Set, Text, Tuple, Union
import os

View File

@ -1,4 +1,4 @@
# Documented in http://zulip.readthedocs.io/en/latest/subsystems/queuing.html
# Documented in https://zulip.readthedocs.io/en/latest/subsystems/queuing.html
from typing import Any, Callable, Dict, List, Mapping, Optional, cast
import signal