Skip to content

Improve documentation links #218

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.

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 2 commits into from
Apr 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ contact_links:
url: https://github.com/arduino/tooling-project-assets#readme
about: Detailed usage documentation is available here.
- name: Learn about GitHub Actions
url: https://docs.github.com/en/actions
url: https://docs.github.com/actions
about: Everything you need to know to get started with GitHub Actions.
- name: Learn about GitHub issue templates
url: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests
url: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests
about: Information about GitHub's issue template feature.
- name: Support request
url: https://forum.arduino.cc/
Expand Down
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file
# See: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file
version: 2

updates:
# Configure check for outdated GitHub Actions actions in workflows.
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/dependabot/README.md
# See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
# See: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
- package-ecosystem: github-actions
directory: / # Check the repository's workflows under /.github/workflows/
schedule:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-ci-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

name: Check CI Workflows Sync

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-community-health-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

name: Check Community Health Files Sync

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-config-sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

name: Check Configuration Files Sync

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-configs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Check Configuration Files

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/check-general-formatting-task.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-general-formatting-task.md
name: Check General Formatting

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
pull_request:
Expand All @@ -18,7 +18,7 @@ jobs:
steps:
- name: Set environment variables
run: |
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV"

- name: Checkout repository
Expand Down Expand Up @@ -46,7 +46,7 @@ jobs:
# Give the binary a standard name
mv "${{ env.EC_INSTALL_PATH }}/bin/ec-linux-amd64" "${{ env.EC_INSTALL_PATH }}/bin/ec"
# Add installation to PATH:
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
echo "${{ env.EC_INSTALL_PATH }}/bin" >> "$GITHUB_PATH"

- name: Check formatting
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-license.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ env:
# SPDX identifier: https://spdx.org/licenses/
EXPECTED_LICENSE_TYPE: CC0-1.0

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-markdown-task.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md
name: Check Markdown

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-prettier-formatting-task.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-prettier-formatting-task.md
name: Check Prettier Formatting

# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-python-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ env:
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
PYTHON_VERSION: "3.9"

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/check-shell-task.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-shell-task.md
name: Check Shell Scripts

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down Expand Up @@ -50,7 +50,7 @@ jobs:
steps:
- name: Set environment variables
run: |
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >> "$GITHUB_ENV"

- name: Checkout repository
Expand All @@ -77,7 +77,7 @@ jobs:
tar --extract --file="${{ steps.download.outputs.name }}"
EXTRACTION_FOLDER="$(basename "${{ steps.download.outputs.name }}" "${{ env.SHELLCHECK_RELEASE_ASSET_SUFFIX }}")"
# Add installation to PATH:
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >> "$GITHUB_PATH"

- name: Run ShellCheck
Expand All @@ -93,7 +93,7 @@ jobs:
steps:
- name: Set environment variables
run: |
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >> "$GITHUB_ENV"

- name: Checkout repository
Expand Down Expand Up @@ -121,7 +121,7 @@ jobs:
# Standardize binary name
mv "${{ env.SHFMT_INSTALL_PATH }}/${{ steps.download.outputs.name }}" "${{ env.SHFMT_INSTALL_PATH }}/shfmt"
# Add installation to PATH:
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
echo "${{ env.SHFMT_INSTALL_PATH }}" >> "$GITHUB_PATH"

- name: Format shell scripts
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-taskfiles.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-taskfiles.md
name: Check Taskfiles

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-workflows-task.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/master/workflow-templates/check-workflows-task.md
name: Check Workflows

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-yaml-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ env:
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
PYTHON_VERSION: "3.9"

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spell-check-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ env:
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
PYTHON_VERSION: "3.9"

# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
pull_request:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/sync-labels.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md
name: Sync Labels

# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
push:
paths:
Expand Down Expand Up @@ -85,7 +85,7 @@ jobs:
steps:
- name: Set environment variables
run: |
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV"

- name: Determine whether to dry run
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/test-install-script.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
# Run every day at 03:00 UTC to catch breakage caused by external events
- cron: "0 3 * * *"
# workflow_dispatch event allows the workflow to be triggered manually.
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch
workflow_dispatch:

env:
Expand Down Expand Up @@ -103,7 +103,7 @@ jobs:
- name: Set install path environment variable
shell: bash
run: |
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
echo "BINDIR=${{ runner.temp }}/custom-installation-folder" >> "$GITHUB_ENV"

- name: Download script artifact
Expand Down Expand Up @@ -209,7 +209,7 @@ jobs:
- name: Set install path environment variables
shell: bash
run: |
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable
FIRST_INSTALLATION_FOLDER="first-installation-folder"
echo "FIRST_INSTALLATION_FOLDER=${FIRST_INSTALLATION_FOLDER}" >> "$GITHUB_ENV"
echo "FIRST_BINDIR=${{ runner.temp }}/${FIRST_INSTALLATION_FOLDER}" >> "$GITHUB_ENV"
Expand Down Expand Up @@ -239,7 +239,7 @@ jobs:
- name: Add first installation to PATH
shell: bash
run: |
# See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path
# See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path
echo "${{ env.FIRST_BINDIR }}" >> "$GITHUB_PATH"

- name: Check script output with previous installation in PATH (non-Windows)
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-python-poetry-task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ env:
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
PYTHON_VERSION: "3.9"

# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
on:
create:
push:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The [Arduino](https://www.arduino.cc/) Tooling Team's collection of reusable pro

## GitHub Actions workflow templates

The [`workflow-templates` folder](workflow-templates) contains a collection of [GitHub Actions workflows](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow) which can be used in any applicable repository either as-is or with minor project-specific configuration.
The [`workflow-templates` folder](workflow-templates) contains a collection of [GitHub Actions workflows](https://docs.github.com/actions/quickstart#creating-your-first-workflow) which can be used in any applicable repository either as-is or with minor project-specific configuration.

More information available [here](workflow-templates#readme).

Expand Down
6 changes: 3 additions & 3 deletions issue-templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A menu of issue categories will be presented when the user begins the issue creation process. This "template chooser" also contains links to relevant information, which can redirect support requests or other inappropriate/unproductive uses of the issue tracker.

A link to the default organization level [security policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository) (using [the default organization-level one](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) if one is not present for the repository) is displayed in the template chooser, helping to ensure that vulnerability disclosures are done according to policy.
A link to the default organization level [security policy](https://docs.github.com/code-security/getting-started/adding-a-security-policy-to-your-repository) (using [the default organization-level one](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) if one is not present for the repository) is displayed in the template chooser, helping to ensure that vulnerability disclosures are done according to policy.

If none of the issue types are applicable, the user can click the "Open a blank issue" link at the bottom of the issue template chooser page to get the previous issue creation behavior.

Expand All @@ -17,5 +17,5 @@ Each subfolder contains a set of issue templates for a specific application. Doc

## References

- https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
- https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
- https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates
- https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
8 changes: 4 additions & 4 deletions issue-templates/minimal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Replace `REPO_OWNER/REPO_NAME` in the `contact_links[0].url` field of `config.ym

Add links for any additional relevant resources to the `contact_links[]` field of `config.yml`.

Reference: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
Reference: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

## Commit message

Expand All @@ -48,12 +48,12 @@ process.
## PR message

```markdown
Although providing a structured template for filling information into an issue report is not appropriate for this project, the [GitHub issue template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) system offers some additional useful features for automating issue tracker maintenance tasks:
Although providing a structured template for filling information into an issue report is not appropriate for this project, the [GitHub issue template](https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) system offers some additional useful features for automating issue tracker maintenance tasks:

- [Template chooser](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser) allows redirecting support requests via "Contact Links", and also provides a prominent link to
- [Template chooser](https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser) allows redirecting support requests via "Contact Links", and also provides a prominent link to
security policy to guide vulnerability disclosures.
- Encouraging the reporter to fit their report into a specific issue category results in more clarity.
- Automatic [labeling](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) according to template choice allows the reporter to do the initial classification.
- Automatic [labeling](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels) according to template choice allows the reporter to do the initial classification.

This minimal issue template system provides these benefits without making any changes to the actual issue writing process.
```
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ contact_links:
url: https://github.com/REPO_OWNER/REPO_NAME#readme
about: Detailed usage documentation is available here.
- name: Learn about GitHub Actions
url: https://docs.github.com/en/actions
url: https://docs.github.com/actions
about: Everything you need to know to get started with GitHub Actions.
- name: Support request
url: https://forum.arduino.cc/
Expand Down
4 changes: 2 additions & 2 deletions other/installation-script/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install.
```

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

If you want to download a specific PRODUCT_NAME version, for example `0.9.0` or `nightly-latest`, pass the version
Expand All @@ -36,7 +36,7 @@ curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install.
Pre-built binaries for all the supported platforms are available for download from the links below.

If you would like to use the `REPO_NAME` 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 PRODUCT_NAME installation path to your
in your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your
`PATH` environment variable.

### Latest release
Expand Down
2 changes: 1 addition & 1 deletion workflow-templates/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GitHub Actions workflow templates

A collection of reusable [GitHub Actions workflows](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow).
A collection of reusable [GitHub Actions workflows](https://docs.github.com/actions/quickstart#creating-your-first-workflow).

## Documentation

Expand Down
Loading