Skip to content

Improve and correct links in documentation #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 15, 2022
Merged

Improve and correct links in documentation #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
31aab3b
Fix broken link in documentation
per1234 Mar 12, 2022
adbabd2
Update redirecting links in documentation
per1234 Mar 11, 2022
be98b2a
Configure links to allow localization
per1234 Mar 12, 2022
91b2479
Point user links to docs for "latest" version
per1234 Mar 12, 2022
484ccbd
Target sketch specification reference links to appropriate section
per1234 Mar 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ There are several ways you can get involved:
| - Bug fix<br/>- Enhancement | Pull Request (read the [pull request guidelines][prs]) |
| Monetary | - [Donate][donate]<br/>- [Buy official products][store] |

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

## Issue Reports

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

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

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

### Qualities of an excellent report

Expand All @@ -55,22 +55,22 @@ submitting a PR:

- Create small PRs that are narrowly focused on addressing a single concern.
- Write tests for the code you wrote.
- Maintain [**clean commit history**](http://www.freshconsulting.com/atomic-commits) and use
[**meaningful commit messages**](http://chris.beams.io/posts/git-commit). PRs with messy commit history are difficult
to review and require a lot of work to be merged.
- Maintain [**clean commit history**](https://www.freshconsulting.com/insights/blog/atomic-commits/) and use
[**meaningful commit messages**](https://cbea.ms/git-commit/). PRs with messy commit history are difficult to review
and require a lot of work to be merged.
- <a id="breaking"></a> If the PR contains a breaking change, please start the commit message and PR title with the
string **[breaking]**. Don't forget to describe in the PR description what changes users might need to make in their
workflow or application due to this PR. A breaking change is a change that forces users to change their command-line
invocations or parsing of the JSON formatted output when upgrading from an older version of Arduino Lint.
- PR titles indirectly become part of the CHANGELOG so it's crucial to provide a good record of **what** change is being
made in the title; **why** it was made will go in the PR description, along with
[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)
[a link to a GitHub issue](https://docs.github.com/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
if one exists.
- Open your PR against the `main` branch.
- Your PR must pass all [CI](https://en.wikipedia.org/wiki/Continuous_integration) tests before we will merge it. You
can run the CI in your fork by clicking the "Actions" tab and then the "I understand my workflows..." button. If
you're seeing an error and don't think it's your fault, it may not be! The reviewer will help you if there are test
failures that seem not related to the change you are making.
- Your PR must pass all [CI](https://wikipedia.org/wiki/Continuous_integration) tests before we will merge it. You can
run the CI in your fork by clicking the "Actions" tab and then the "I understand my workflows..." button. If you're
seeing an error and don't think it's your fault, it may not be! The reviewer will help you if there are test failures
that seem not related to the change you are making.

### Development prerequisites

Expand Down Expand Up @@ -183,7 +183,7 @@ Unfortunately, **Licensed** does not have Windows support.

An updated cache is also generated whenever the cache is found to be outdated by the by the "Check Go Dependencies" CI
workflow and made available for download via the `dep-licenses-cache`
[workflow artifact](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts).
[workflow artifact](https://docs.github.com/actions/managing-workflow-runs/downloading-workflow-artifacts).

<a id="linting-and-formatting"></a> <a id="configuration-files-formatting"></a> <a id="documentation-formatting"></a>

Expand Down
16 changes: 8 additions & 8 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ accepted by this flag are:

### Library Manager setting

[Arduino Library Manager](https://www.arduino.cc/en/guide/libraries#toc3) is the best way to provide installation and
updates of Arduino libraries. In order to be accepted for inclusion in Library Manager, a library is required to meet
[some requirements](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).
[Arduino Library Manager](https://docs.arduino.cc/software/ide-v1/tutorials/installing-libraries#using-the-library-manager)
is the best way to provide installation and updates of Arduino libraries. In order to be accepted for inclusion in
Library Manager, a library is required to meet
[some requirements](https://github.com/arduino/library-registry/blob/main/FAQ.md#readme).

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

Expand Down Expand Up @@ -75,11 +76,10 @@ Additional configuration options intended for internal use or development can be
## Continuous integration

**Arduino Lint** would be a great addition to your
[continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) system. Running the tool after each
change to the project can allow you to identify any problems that were introduced.
[continuous integration](https://wikipedia.org/wiki/Continuous_integration) system. Running the tool after each change
to the project can allow you to identify any problems that were introduced.

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

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

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

Feedback is welcome! Please submit feature requests or bug reports to the
[issue tracker](CONTRIBUTING.md#issue-reports).
8 changes: 4 additions & 4 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta
```

If you would like to use the `arduino-lint` command from any location, install Arduino Lint to a directory already in
your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path to your
`PATH` environment variable.
your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path to your `PATH`
environment variable.

If you want to download a specific Arduino Lint version, for example `0.9.0` or `nightly-latest`, pass the version
number as a parameter like this:
Expand All @@ -36,8 +36,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta
Pre-built binaries for all the supported platforms are available for download from the links below.

If you would like to use the `arduino-lint` command from any location, extract the downloaded file to a directory
already in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path
to your `PATH` environment variable.
already in your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path to
your `PATH` environment variable.

### Latest release

Expand Down
26 changes: 13 additions & 13 deletions internal/rule/ruleconfiguration/ruleconfiguration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ var configurations = []Type{
Subcategory: "source code",
ID: "LS008",
Brief: "name-header mismatch",
Description: "The match between the `library.properties` `name` field and the filename in an `#include` directive is a factor in the library's [dependency resolution priority](https://arduino.github.io/arduino-cli/dev/sketch-build-process/#dependency-resolution). It's recommended for the primary header filename to match the library name.",
Description: "The match between the `library.properties` `name` field and the filename in an `#include` directive is a factor in the library's [dependency resolution priority](https://arduino.github.io/arduino-cli/latest/sketch-build-process/#dependency-resolution). It's recommended for the primary header filename to match the library name.",
MessageTemplate: "No header file found matching library name ({{.}}). Best practices are for primary header filename to match library name.",
Reference: "https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format",
DisableModes: nil,
Expand Down Expand Up @@ -559,7 +559,7 @@ var configurations = []Type{
Subcategory: "name field",
ID: "LP018",
Brief: "not in LM index",
Description: "The library name (as defined by `name` field in [the `library.properties` metadata file](https://arduino.github.io/arduino-cli/dev/library-specification/#library-metadata)) was not found in the Library Manager index, but Arduino Lint was run in the [`--library-manager update` mode](https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/#options), indicating that it was expected there.\n\nBecause the `name` value is the identifier used to install the library and define dependencies, it is not allowed to change after the library has been added to the index.",
Description: "The library name (as defined by `name` field in [the `library.properties` metadata file](https://arduino.github.io/arduino-cli/latest/library-specification/#library-metadata)) was not found in the Library Manager index, but Arduino Lint was run in the [`--library-manager update` mode](https://arduino.github.io/arduino-lint/latest/commands/arduino-lint/#options), indicating that it was expected there.\n\nBecause the `name` value is the identifier used to install the library and define dependencies, it is not allowed to change after the library has been added to the index.",
MessageTemplate: "Library name {{.}} not found in the Library Manager index. Library names are not allowed to change after being added to the index.",
Reference: "https://github.com/arduino/library-registry/blob/main/FAQ.md#how-can-i-change-a-librarys-name",
DisableModes: []rulemode.Type{rulemode.Default},
Expand Down Expand Up @@ -1258,7 +1258,7 @@ var configurations = []Type{
Brief: "no readme",
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.",
MessageTemplate: "No readme found. Please document your library.",
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes",
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand All @@ -1275,7 +1275,7 @@ var configurations = []Type{
Brief: "no license file",
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.",
MessageTemplate: "No license file found.",
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository",
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand Down Expand Up @@ -1377,7 +1377,7 @@ var configurations = []Type{
Brief: "prohibited character in filename",
Description: "A sketch file's name contains a prohibited character.",
MessageTemplate: "Prohibited character(s) in file name(s): {{.}}",
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-folders-and-files",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand All @@ -1394,7 +1394,7 @@ var configurations = []Type{
Brief: "file name too long",
Description: "The sketch file's name exceeds the maximum length.",
MessageTemplate: "File name(s): {{.}} exceed maximum length.",
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-root-folder",
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#sketch-folders-and-files",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand All @@ -1411,7 +1411,7 @@ var configurations = []Type{
Brief: ".pde extension",
Description: "A sketch file uses the deprecated `.pde` file extension. The .pde extension is used by both [Processing](https://processing.org/) sketches and Arduino sketches. If the project has supplemental Processing sketches, they should either be in the [`data` subfolder of the sketch](https://arduino.github.io/arduino-cli/latest/sketch-specification/#data-subfolder) or in the [`extras` folder of the library](https://arduino.github.io/arduino-cli/latest/library-specification/#extra-documentation). Arduino sketches should use the modern `.ino` extension.",
MessageTemplate: "{{.}} uses deprecated .pde file extension. Use .ino for Arduino sketches.",
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification",
Reference: "https://arduino.github.io/arduino-cli/latest/sketch-specification/#additional-code-files",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand Down Expand Up @@ -1462,7 +1462,7 @@ var configurations = []Type{
Brief: "no readme",
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.",
MessageTemplate: "No readme found. Please document your sketch.",
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes",
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand All @@ -1479,7 +1479,7 @@ var configurations = []Type{
Brief: "no license file",
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.",
MessageTemplate: "No license file found.",
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository",
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand Down Expand Up @@ -1530,7 +1530,7 @@ var configurations = []Type{
Brief: "no readme",
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.",
MessageTemplate: "No readme found. Please document your boards platform.",
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes",
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes",
DisableModes: []rulemode.Type{rulemode.Default},
EnableModes: nil,
InfoModes: nil,
Expand All @@ -1547,7 +1547,7 @@ var configurations = []Type{
Brief: "no license file",
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.",
MessageTemplate: "No license file found.",
Reference: "https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/licensing-a-repository",
Reference: "https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository",
DisableModes: []rulemode.Type{rulemode.Default},
EnableModes: nil,
InfoModes: nil,
Expand Down Expand Up @@ -2907,7 +2907,7 @@ var configurations = []Type{
Brief: "upload.field.FIELD_NAME > max length",
Description: "The `tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME` property in the platform's `platform.txt` configuration file is longer than the maximum length.",
MessageTemplate: "upload.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME property is longer than the maximum length for fields: {{.}}",
Reference: "https://arduino.github.io/arduino-cli/dev/platform-specification/#user-provided-fields",
Reference: "https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand All @@ -2924,7 +2924,7 @@ var configurations = []Type{
Brief: "upload.field.FIELD_NAME.secret invalid",
Description: "The `tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret` property in the platform's `platform.txt` configuration file has an invalid value.",
MessageTemplate: "tools.UPLOAD_RECIPE_ID.upload.field.FIELD_NAME.secret value is invalid or field(s) {{.}}",
Reference: "https://arduino.github.io/arduino-cli/dev/platform-specification/#user-provided-fields",
Reference: "https://arduino.github.io/arduino-cli/latest/platform-specification/#user-provided-fields",
DisableModes: nil,
EnableModes: []rulemode.Type{rulemode.Default},
InfoModes: nil,
Expand Down