Skip to content

Commit adbabd2

Browse files
committed
Update redirecting links in documentation
Even though these links were still reaching the intended page, it is best not to rely on redirects.
1 parent 31aab3b commit adbabd2

File tree

3 files changed

+18
-19
lines changed

3 files changed

+18
-19
lines changed

docs/CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ There are several ways you can get involved:
1212
| - Bug fix<br/>- Enhancement | Pull Request (read the [pull request guidelines][prs]) |
1313
| Monetary | - [Donate][donate]<br/>- [Buy official products][store] |
1414

15-
[forum]: https://forum.arduino.cc/index.php?board=3.0
15+
[forum]: https://forum.arduino.cc/c/using-arduino/project-guidance/19
1616
[issues]: #issue-reports
1717
[nightly]: installation.md#nightly-builds
1818
[prs]: #pull-requests
19-
[donate]: https://www.arduino.cc/en/Main/Contribute
19+
[donate]: https://www.arduino.cc/en/donate/
2020
[store]: https://store.arduino.cc
2121

2222
## Issue Reports
2323

2424
Do you need help or have a question about using Arduino Lint? Support requests should be made to the
25-
[Arduino forum](https://forum.arduino.cc/index.php?board=3.0).
25+
[Arduino forum](https://forum.arduino.cc/c/using-arduino/project-guidance/19).
2626

2727
High quality bug reports and feature requests are valuable contributions to the Arduino Lint project.
2828

@@ -31,8 +31,8 @@ High quality bug reports and feature requests are valuable contributions to the
3131
- Give the [nightly build](installation.md#nightly-builds) a test drive to see if your issue was already resolved.
3232
- Search [existing pull requests and issues](https://github.com/arduino/arduino-lint/issues?q=) to see if it was already
3333
reported. If you have additional information to provide about an existing issue, please comment there. You can use
34-
[GitHub's "Reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) if you
35-
only want to express support.
34+
[GitHub's "Reactions" feature](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) if
35+
you only want to express support.
3636

3737
### Qualities of an excellent report
3838

@@ -55,16 +55,16 @@ submitting a PR:
5555

5656
- Create small PRs that are narrowly focused on addressing a single concern.
5757
- Write tests for the code you wrote.
58-
- Maintain [**clean commit history**](http://www.freshconsulting.com/atomic-commits) and use
59-
[**meaningful commit messages**](http://chris.beams.io/posts/git-commit). PRs with messy commit history are difficult
60-
to review and require a lot of work to be merged.
58+
- Maintain [**clean commit history**](https://www.freshconsulting.com/insights/blog/atomic-commits/) and use
59+
[**meaningful commit messages**](https://cbea.ms/git-commit/). PRs with messy commit history are difficult to review
60+
and require a lot of work to be merged.
6161
- <a id="breaking"></a> If the PR contains a breaking change, please start the commit message and PR title with the
6262
string **[breaking]**. Don't forget to describe in the PR description what changes users might need to make in their
6363
workflow or application due to this PR. A breaking change is a change that forces users to change their command-line
6464
invocations or parsing of the JSON formatted output when upgrading from an older version of Arduino Lint.
6565
- PR titles indirectly become part of the CHANGELOG so it's crucial to provide a good record of **what** change is being
6666
made in the title; **why** it was made will go in the PR description, along with
67-
[a link to a GitHub issue](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)
67+
[a link to a GitHub issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
6868
if one exists.
6969
- Open your PR against the `main` branch.
7070
- Your PR must pass all [CI](https://en.wikipedia.org/wiki/Continuous_integration) tests before we will merge it. You

docs/index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ accepted by this flag are:
4141
[Arduino Library Manager](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#using-the-library-manager)
4242
is the best way to provide installation and updates of Arduino libraries. In order to be accepted for inclusion in
4343
Library Manager, a library is required to meet
44-
[some requirements](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).
44+
[some requirements](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme).
4545

4646
**Arduino Lint** provides checks for these requirements as well, controlled by the `--library-manager` flag.
4747

@@ -79,8 +79,7 @@ Additional configuration options intended for internal use or development can be
7979
[continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) system. Running the tool after each
8080
change to the project can allow you to identify any problems that were introduced.
8181

82-
This is easily done by using the `arduino/arduino-lint-action`
83-
[GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions) action:
82+
This is easily done by using the `arduino/arduino-lint-action` [GitHub Actions](https://docs.github.com/actions) action:
8483
https://github.com/arduino/arduino-lint-action
8584

8685
Add [a simple workflow file](https://github.com/arduino/arduino-lint-action#usage) to the repository of your Arduino
@@ -89,7 +88,7 @@ project and GitHub will automatically run Arduino Lint on every pull request and
8988
## Support and feedback
9089

9190
You can discuss or get assistance with using **Arduino Lint** on the
92-
[Arduino Forum](https://forum.arduino.cc/index.php?board=3.0).
91+
[Arduino Forum](https://forum.arduino.cc/c/using-arduino/project-guidance/19).
9392

9493
Feedback is welcome! Please submit feature requests or bug reports to the
9594
[issue tracker](CONTRIBUTING.md#issue-reports).

internal/rule/ruleconfiguration/ruleconfiguration.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -1258,7 +1258,7 @@ var configurations = []Type{
12581258
Brief: "no readme",
12591259
Description: "None of the standard README file names (e.g., `README.md`) were found in the library's root folder. This file provides interested parties with a convenient and standardized location to get information about the project.",
12601260
MessageTemplate: "No readme found. Please document your library.",
1261-
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes",
1261+
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes",
12621262
DisableModes: nil,
12631263
EnableModes: []rulemode.Type{rulemode.Default},
12641264
InfoModes: nil,
@@ -1275,7 +1275,7 @@ var configurations = []Type{
12751275
Brief: "no license file",
12761276
Description: "None of the standard license file names (e.g., `LICENSE.txt`) were found in the library's root folder. This file provides interested parties with a convenient and standardized location to get information about the project's licensing and is also used by GitHub for automatic license type classification.",
12771277
MessageTemplate: "No license file found.",
1278-
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository",
1278+
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository",
12791279
DisableModes: nil,
12801280
EnableModes: []rulemode.Type{rulemode.Default},
12811281
InfoModes: nil,
@@ -1462,7 +1462,7 @@ var configurations = []Type{
14621462
Brief: "no readme",
14631463
Description: "None of the standard README file names (e.g., `README.md`) were found in the sketch folder. This file provides interested parties with a convenient and standardized location to get information about the project.",
14641464
MessageTemplate: "No readme found. Please document your sketch.",
1465-
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes",
1465+
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes",
14661466
DisableModes: nil,
14671467
EnableModes: []rulemode.Type{rulemode.Default},
14681468
InfoModes: nil,
@@ -1479,7 +1479,7 @@ var configurations = []Type{
14791479
Brief: "no license file",
14801480
Description: "None of the standard license file names (e.g., `LICENSE.txt`) were found in the sketch's root folder. This file provides interested parties with a convenient and standardized location to get information about the project's licensing and is also used by GitHub for automatic license type classification.",
14811481
MessageTemplate: "No license file found.",
1482-
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository",
1482+
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository",
14831483
DisableModes: nil,
14841484
EnableModes: []rulemode.Type{rulemode.Default},
14851485
InfoModes: nil,
@@ -1530,7 +1530,7 @@ var configurations = []Type{
15301530
Brief: "no readme",
15311531
Description: "None of the standard README file names (e.g., `README.md`) were found in the platform folder. This file provides interested parties with a convenient and standardized location to get information about the project.",
15321532
MessageTemplate: "No readme found. Please document your boards platform.",
1533-
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes",
1533+
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes",
15341534
DisableModes: []rulemode.Type{rulemode.Default},
15351535
EnableModes: nil,
15361536
InfoModes: nil,
@@ -1547,7 +1547,7 @@ var configurations = []Type{
15471547
Brief: "no license file",
15481548
Description: "None of the standard license file names (e.g., `LICENSE.txt`) were found in the platform folder. This file provides interested parties with a convenient and standardized location to get information about the project's licensing and is also used by GitHub for automatic license type classification.",
15491549
MessageTemplate: "No license file found.",
1550-
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository",
1550+
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository",
15511551
DisableModes: []rulemode.Type{rulemode.Default},
15521552
EnableModes: nil,
15531553
InfoModes: nil,

0 commit comments

Comments
 (0)