From da3396b4d7a3581cad0ca76c8e21f42a06cb24eb Mon Sep 17 00:00:00 2001 From: Anders Kaseorg Date: Tue, 31 Aug 2021 14:32:37 -0700 Subject: [PATCH] docs: Update links for other repository branch renames. GitHub redirects these, but we should use the canonical URLs. Signed-off-by: Anders Kaseorg (cherry picked from commit 1ce12191aad11f4d0204ab17f3e17d574a253138) --- docs/contributing/gsoc-ideas.md | 2 +- docs/contributing/zulipbot-usage.md | 2 +- docs/documentation/api.md | 4 ++-- docs/subsystems/events-system.md | 2 +- docs/subsystems/widgets.md | 2 +- templates/zerver/api/deploying-bots.md | 2 +- .../zerver/api/non-webhook-integrations.md | 2 +- templates/zerver/api/running-bots.md | 2 +- templates/zerver/api/writing-bots.md | 18 +++++++++--------- templates/zerver/help/custom-certificates.md | 2 +- zerver/openapi/zulip.yaml | 2 +- zerver/views/auth.py | 2 +- zerver/webhooks/trello/doc.md | 2 +- 13 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/contributing/gsoc-ideas.md b/docs/contributing/gsoc-ideas.md index 109807ef37..2aa2f63023 100644 --- a/docs/contributing/gsoc-ideas.md +++ b/docs/contributing/gsoc-ideas.md @@ -391,7 +391,7 @@ CSS](https://github.com/zulip/zulip/). being built into Zulip. And then for built-in bots, one should be able to click a few buttons of configuration on the web to set them up and include them in your organization. We've developed a number of example bots - in the (`zulip_bots`](https://github.com/zulip/python-zulip-api/tree/master/zulip_bots) + in the [`zulip_bots`](https://github.com/zulip/python-zulip-api/tree/main/zulip_bots) PyPI package. **Skills recommended**: Python and JavaScript/CSS, plus devops skills (Linux deployment, Docker, Puppet etc.) are all useful here. diff --git a/docs/contributing/zulipbot-usage.md b/docs/contributing/zulipbot-usage.md index 520d93e9e4..7fed242524 100644 --- a/docs/contributing/zulipbot-usage.md +++ b/docs/contributing/zulipbot-usage.md @@ -90,5 +90,5 @@ assignee(s) if they are still working on the issue. If you wish to help develop and contribute to **@zulipbot**, check out the [zulip/zulipbot](https://github.com/zulip/zulipbot) repository on GitHub and read the project's [contributing -guidelines](https://github.com/zulip/zulipbot/blob/master/.github/CONTRIBUTING.md#contributing) for +guidelines](https://github.com/zulip/zulipbot/blob/main/.github/CONTRIBUTING.md#contributing) for more information. diff --git a/docs/documentation/api.md b/docs/documentation/api.md index 09f73ca056..7f9e014343 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -237,7 +237,7 @@ above. bindings don't have a dedicated method for a specific API call, you may either use `client.call_endpoint` or add a dedicated function to the [zulip PyPI - package](https://github.com/zulip/python-zulip-api/tree/master/zulip). + package](https://github.com/zulip/python-zulip-api/tree/main/zulip). Ultimately, the goal is for every endpoint to be documented the latter way, but it's useful to be able to write working documentation for an endpoint that isn't supported by @@ -285,7 +285,7 @@ above. in `zerver/openapi/zulip.yaml`, which mentions the API feature level at which they were added. -[javascript-examples]: https://github.com/zulip/zulip-js/tree/master/examples +[javascript-examples]: https://github.com/zulip/zulip-js/tree/main/examples ## Why a custom system? diff --git a/docs/subsystems/events-system.md b/docs/subsystems/events-system.md index 25bd249a4d..d38dcb931a 100644 --- a/docs/subsystems/events-system.md +++ b/docs/subsystems/events-system.md @@ -138,7 +138,7 @@ soon as it attempted to send them to the client; if that specific HTTP response didn't reach the client due to a network TCP failure, then those events could be lost). -[api-bindings-code]: https://github.com/zulip/python-zulip-api/blob/master/zulip/zulip/__init__.py +[api-bindings-code]: https://github.com/zulip/python-zulip-api/blob/main/zulip/zulip/__init__.py The queue servers are a very high-traffic system, processing at a minimum one request for every message delivered to every Zulip client. diff --git a/docs/subsystems/widgets.md b/docs/subsystems/widgets.md index 3dcd452bca..87dbd33094 100644 --- a/docs/subsystems/widgets.md +++ b/docs/subsystems/widgets.md @@ -303,7 +303,7 @@ the **zform** to the client rendering it. First, -[here](https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/zulip_bots/bots/trivia_quiz/trivia_quiz.py) +[here](https://github.com/zulip/python-zulip-api/blob/main/zulip_bots/zulip_bots/bots/trivia_quiz/trivia_quiz.py) is the code that produces the JSON. ``` py diff --git a/templates/zerver/api/deploying-bots.md b/templates/zerver/api/deploying-bots.md index bbe4a0ccda..27342aca2b 100644 --- a/templates/zerver/api/deploying-bots.md +++ b/templates/zerver/api/deploying-bots.md @@ -192,7 +192,7 @@ running it manually. * Edit the `<>` sections according to your preferences. -[supervisord-config-file]: https://raw.githubusercontent.com/zulip/python-zulip-api/master/zulip_botserver/zulip-botserver-supervisord.conf +[supervisord-config-file]: https://raw.githubusercontent.com/zulip/python-zulip-api/main/zulip_botserver/zulip-botserver-supervisord.conf 1. Update *supervisord* to read the configuration file: diff --git a/templates/zerver/api/non-webhook-integrations.md b/templates/zerver/api/non-webhook-integrations.md index 898a148171..560b961ea2 100644 --- a/templates/zerver/api/non-webhook-integrations.md +++ b/templates/zerver/api/non-webhook-integrations.md @@ -8,7 +8,7 @@ them. Zulip supports several other types of integrations. (examples: SVN, Git), where we can get the service to call our integration (by shelling out or otherwise), passing in the required data. Our preferred model for these is to ship these integrations in the - [Zulip Python API distribution](https://github.com/zulip/python-zulip-api/tree/master/zulip), + [Zulip Python API distribution](https://github.com/zulip/python-zulip-api/tree/main/zulip), within the `integrations` directory there. 1. **Plugin integrations** (examples: diff --git a/templates/zerver/api/running-bots.md b/templates/zerver/api/running-bots.md index fb6b78ee73..535ab8f2f6 100644 --- a/templates/zerver/api/running-bots.md +++ b/templates/zerver/api/running-bots.md @@ -7,7 +7,7 @@ to messages in Zulip. This guide will show you how to run an existing Zulip bot found in [zulip_bots/bots]( -https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots). +https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots). You'll need: diff --git a/templates/zerver/api/writing-bots.md b/templates/zerver/api/writing-bots.md index a13371c955..84262719c1 100644 --- a/templates/zerver/api/writing-bots.md +++ b/templates/zerver/api/writing-bots.md @@ -114,7 +114,7 @@ we have a little tool to help you out: `zulip-terminal` * [Install all requirements](#installing-a-development-version-of-the-zulip-bots-package). * Run `zulip-terminal` to test one of the bots in - [`zulip_bots/bots`](https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots). + [`zulip_bots/bots`](https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots). Example invocations are below: @@ -374,7 +374,7 @@ every call to `put` and `get`, respectively. Bots, like most software that you want to work, should have unit tests. In this section, we detail our framework for writing unit tests for bots. We require that bots in the main -[`python-zulip-api`](https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots) +[`python-zulip-api`](https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots) repository include a reasonable set of unit tests, so that future developers can easily refactor them. @@ -385,7 +385,7 @@ refactor them. ### A simple example Let's have a look at a simple test suite for the [`helloworld`]( - https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots/helloworld) + https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots/helloworld) bot. ``` @@ -419,7 +419,7 @@ The best way to learn about bot tests is to read all the existing tests in the Once you have written a test suite, you want to verify that everything works as expected. * To test a bot in [Zulip's bot directory]( - https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots): + https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots): `tools/test-bots ` * To run all bot tests: `tools/test-bots` @@ -429,13 +429,13 @@ Once you have written a test suite, you want to verify that everything works as This section shows advanced testing techniques for more complicated bots that have configuration files or interact with third-party APIs. *The code for the bot testing library can be found [here]( - https://github.com/zulip/python-zulip-api/blob/master/zulip_bots/zulip_bots/test_lib.py).* + https://github.com/zulip/python-zulip-api/blob/main/zulip_bots/zulip_bots/test_lib.py).* #### Testing bots with config files Some bots, such as [Giphy]( -https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots/giphy), +https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots/giphy), support or require user configuration options to control how the bot works. To test such a bot, you can use the following pattern: @@ -449,7 +449,7 @@ system and gives your test "dummy data" instead. #### Testing bots with internet access Some bots, such as [Giphy]( -https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots/giphy), +https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots/giphy), depend on a third-party service, such as the Giphy webapp, in order to work. Because we want our test suite to be reliable and not add load to these third-party APIs, tests for these services need to have "test fixtures": sample HTTP request/response pairs to @@ -476,7 +476,7 @@ fixtures: } ``` For an example, check out the [giphy bot]( -https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots/giphy). +https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots/giphy). *Tip: You can use [requestbin](https://requestbin.com/) or a similar tool to capture payloads from the service your bot is interacting @@ -484,7 +484,7 @@ with.* #### Examples -Check out our [bots](https://github.com/zulip/python-zulip-api/tree/master/zulip_bots/zulip_bots/bots) +Check out our [bots](https://github.com/zulip/python-zulip-api/tree/main/zulip_bots/zulip_bots/bots) to see examples of bot tests. ## Common problems diff --git a/templates/zerver/help/custom-certificates.md b/templates/zerver/help/custom-certificates.md index 563e648f75..8f4afe24c5 100644 --- a/templates/zerver/help/custom-certificates.md +++ b/templates/zerver/help/custom-certificates.md @@ -108,4 +108,4 @@ server. You'll need to get a certificate file (should end in `.crt` or -[linux]: https://chromium.googlesource.com/chromium/src.git/+/master/docs/linux/cert_management.md +[linux]: https://chromium.googlesource.com/chromium/src.git/+/main/docs/linux/cert_management.md diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index 53863aa072..8949d61851 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -145,7 +145,7 @@ paths: description: | The highest event ID in this queue that you've received and wish to acknowledge. See the [code for - `call_on_each_event`](https://github.com/zulip/python-zulip-api/blob/master/zulip/zulip/__init__.py) + `call_on_each_event`](https://github.com/zulip/python-zulip-api/blob/main/zulip/zulip/__init__.py) in the [zulip Python module](https://github.com/zulip/python-zulip-api) for an example implementation of correctly processing each event diff --git a/zerver/views/auth.py b/zerver/views/auth.py index 7ef4175177..62fa7d0fbb 100644 --- a/zerver/views/auth.py +++ b/zerver/views/auth.py @@ -759,7 +759,7 @@ def login_page( # context_data attribute. This attribute doesn't exist otherwise. It is # added in SimpleTemplateResponse class, which is a derived class of # HttpResponse. See django.template.response.SimpleTemplateResponse, - # https://github.com/django/django/blob/master/django/template/response.py#L19. + # https://github.com/django/django/blob/2.0/django/template/response.py#L19 update_login_page_context(request, template_response.context_data) return template_response diff --git a/zerver/webhooks/trello/doc.md b/zerver/webhooks/trello/doc.md index a77f2aea23..0adfb3fe86 100644 --- a/zerver/webhooks/trello/doc.md +++ b/zerver/webhooks/trello/doc.md @@ -57,7 +57,7 @@ Get Zulip notifications from your Trello boards! 1. You can delete `zulip_trello.py` from your computer if you'd like. -[2]: https://raw.githubusercontent.com/zulip/python-zulip-api/master/zulip/integrations/trello/zulip_trello.py +[2]: https://raw.githubusercontent.com/zulip/python-zulip-api/main/zulip/integrations/trello/zulip_trello.py {!congrats.md!}