Skip to content

[skip changelog] Update broken or outdated references to docs workflow #890

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 1 commit into from
Aug 4, 2020
Merged

[skip changelog] Update broken or outdated references to docs workflow #890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
Expand Down
4 changes: 2 additions & 2 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down