Skip to content

Commit 4bf5806

Browse files
committed
Update redirecting documentation links
Even though these links were still reaching the intended page, it is best not to rely on redirects continuing to work indefinitely.
1 parent e13250f commit 4bf5806

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

.github/workflows/check-general-formatting.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Check General Formatting
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
pull_request:

.github/workflows/check-license.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ env:
66
# SPDX identifier: https://spdx.org/licenses/
77
EXPECTED_LICENSE_TYPE: CC0-1.0
88

9-
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
9+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
1010
on:
1111
push:
1212
paths:

.github/workflows/check-markdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Check Markdown
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
paths:

.github/workflows/check-prettier-formatting.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Check Prettier Formatting
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
paths:

.github/workflows/check-toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Check ToC
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
paths:

.github/workflows/check-workflows.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Check Workflows
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
paths:

.github/workflows/check-yaml.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Check YAML
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
paths:

.github/workflows/spell-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Spell Check
22

3-
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
3+
# See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
44
on:
55
push:
66
pull_request:

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,24 +70,24 @@ First of all, check the existing RFCs. There may already be one for your proposa
7070
#### Discussion channels
7171

7272
- Talk with the user community on [the Arduino Forum](https://forum.arduino.cc/).
73-
- Talk with Arduino developers on [the Arduino Developers Mailing List](https://groups.google.com/a/arduino.cc/forum/#!forum/developers).
73+
- Talk with Arduino developers on [the Arduino Developers Mailing List](https://groups.google.com/a/arduino.cc/g/developers).
7474

7575
### 2. Write
7676

77-
1. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) this repository.
77+
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository.
7878
1. Copy `0000-template.md` to `RFCs/0000-my-proposal.md` (replacing "my-proposal" with the RFC title). Don't assign an RFC number yet; this is going to be set according to the ID number GitHub assigns the pull request when it's submitted.
7979
1. Fill in the RFC.
8080
- If the RFC document requires supplemental files (e.g., graphics), put them under the `RFCs/assets/0000-my-proposal` folder, where "0000-my-proposal" is the proposal file name.
8181

8282
#### Resources
8383

84-
- [Style Guide](https://tools.ietf.org/html/rfc7322)
85-
- [Requirement levels key words](https://tools.ietf.org/html/rfc2119)
84+
- [Style Guide](https://datatracker.ietf.org/doc/html/rfc7322)
85+
- [Requirement levels key words](https://datatracker.ietf.org/doc/html/rfc2119)
8686
- [Writing guide](https://github.com/inasafe/inasafe/wiki/How-to-write-an-RFC)
8787

8888
### 3. Submit
8989

90-
1. Submit a [pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) from your fork to add the RFC file.
90+
1. Submit a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) from your fork to add the RFC file.
9191
1. Check which identifier number GitHub has assigned your pull request. This will be shown immediately after the pull request title, prefixed with `#`.
9292
1. Rename the RFC file in your fork to use the pull request number, padding with zeros to make the number have four digits. For example, if the pull request number was `#42`, the RFC file should be renamed from `RFCs/0000-my-proposal.md` to `RFCs/0042-my-proposal.md`.
9393
- Note that any changes you make to the files in the branch of your fork the pull request was submitted from will automatically update the pull request.
@@ -99,27 +99,27 @@ When the pull request is submitted, some automated checks will be done to make s
9999
### 5. Review and revision
100100

101101
Interested parties should now review and discuss the RFC. This is done using GitHub's pull request review system:<br />
102-
https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews
102+
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews
103103

104104
In order to allow everyone the opportunity to comment, a minimum period of 14 days (starting from the submission of the pull request for review) is provided before merging or rejecting the RFC.
105105

106106
During this time, the RFC author and reviewers should work together to reach consensus and make necessary adjustments or improvements to the RFC. It's important for the RFC author to be responsive during the review period, so make sure to allocate some time for this during the review period before submitting the pull request.
107107

108108
#### Review
109109

110-
- Comments and discussion about specific lines can be done via [line comments](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).
111-
- Requests for specific changes to the text can be done using GitHub's ["Suggestions" feature](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request#starting-a-review:~:text=Optionally%2C%20to%20suggest%20a%20specific%20change). This allows the RFC author to easily accept them via the GitHub web interface.
112-
- General feedback and discussion can be done via the [review message](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request#submitting-your-review) or in [the pull request conversation thread](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#about-pull-request-comments).
110+
- Comments and discussion about specific lines can be done via [line comments](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request).
111+
- Requests for specific changes to the text can be done using GitHub's ["Suggestions" feature](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#:~:text=Optionally%2C%20to%20suggest%20a%20specific%20change). This allows the RFC author to easily accept them via the GitHub web interface.
112+
- General feedback and discussion can be done via the [review message](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#submitting-your-review) or in [the pull request conversation thread](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#about-pull-request-comments).
113113

114114
#### Revision
115115

116116
The author can make revisions to the RFC in response to the reviews.
117117

118118
Note that any changes you make to the files in the branch of your fork the pull request was submitted from will automatically update the pull request so there is no need to open a new pull request for the modifications.
119119

120-
If in agreement with a change requested via GitHub's "Suggestions" feature, simply [click the "Commit suggestion" button](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request).
120+
If in agreement with a change requested via GitHub's "Suggestions" feature, simply [click the "Commit suggestion" button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request).
121121

122-
Once a review discussion has been resolved, [click the "Resolve conversation" button](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations) to clearly indicate this to all involved parties. This is done automatically for committed "suggestions".
122+
Once a review discussion has been resolved, [click the "Resolve conversation" button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#resolving-conversations) to clearly indicate this to all involved parties. This is done automatically for committed "suggestions".
123123

124124
Although it is normally best practices, during the RFC review process the technique of doing a "squash" or "fixup" and force pushing to the PR branch to maintain an atomic commit history should be avoided. The reason is that this makes it a little more difficult for reviewers to follow the revisions that have been made. The maintainer will squash the commits as needed at the time of the merge.
125125

0 commit comments

Comments
 (0)