diff --git a/README.md b/README.md index bb3389ca0b5..441462973c2 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ tools needed to use any Arduino compatible board and platforms. [![tests-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=test) [![nightly-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=nightly) -[![docs-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=docs) +[![docs-badge]](https://github.com/Arduino/arduino-cli/actions?workflow=publish-docs) [![codecov-badge]](https://codecov.io/gh/arduino/arduino-cli) > **Note:** this software is currently under active development: anything can change at any time, API and UI must be @@ -42,7 +42,7 @@ e-mail contact: security@arduino.cc [tests-badge]: https://github.com/Arduino/arduino-cli/workflows/test/badge.svg [nightly-badge]: https://github.com/Arduino/arduino-cli/workflows/nightly/badge.svg -[docs-badge]: https://github.com/Arduino/arduino-cli/workflows/docs/badge.svg +[docs-badge]: https://github.com/Arduino/arduino-cli/workflows/publish-docs/badge.svg [codecov-badge]: https://codecov.io/gh/arduino/arduino-cli/branch/master/graph/badge.svg [install]: https://arduino.github.io/arduino-cli/installation [user documentation]: https://arduino.github.io/arduino-cli/ diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 993f06a1453..3ca764bbf4d 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -281,7 +281,7 @@ case of failures we might ask you to update the PR with correct formatting. ### Docs automation In order to avoid unwanted changes to the public website hosting the Arduino CLI documentation, only Mike is allowed to -push changes to the `gh-pages` branch, and this only happens from within the CI, in a workflow named [docs][11]. +push changes to the `gh-pages` branch, and this only happens from within the CI, in a workflow named [publish-docs][11]. The CI is responsible for guessing which version of the Arduino CLI we're building docs for, so that generated contents will be stored in the appropriate section of the documentation website. Because this guessing might be fairly complex, @@ -344,7 +344,7 @@ If your PR doesn't need to be included in the changelog, please start the PR tit [7]: https://pages.github.com/ [9]: https://www.mkdocs.org/ [10]: https://github.com/jimporter/mike -[11]: https://github.com/arduino/arduino-cli/blob/master/.github/workflows/docs.yaml +[11]: https://github.com/arduino/arduino-cli/blob/master/.github/workflows/publish-docs.yaml [12]: https://github.com/arduino/arduino-cli/blob/master/docs/build.py [prettier-website]: https://prettier.io/ [prettier-vscode-extension]: https://github.com/prettier/prettier-vscode