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.

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

merged 1 commit into from
Aug 4, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 4, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Bug fix.

  • What is the current behavior?

The docs workflow was split into two workflows: publish-docs and validate-docs, but the references to the original workflow were not updated. This resulted in two problems:

  • The "docs" badge in the readme won't reflect the true state of the documentation publishing system
  • Broken link in CONTRIBUTING.md
  • What is the new behavior?

All references to the docs workflow have been updated to point to the publish-docs workflow.

  • Does this PR introduce a breaking change?

No

The docs workflow was split into two workflows: publish-docs and validate-docs, but the references to the original workflow were not updated.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Aug 4, 2020
@per1234 per1234 merged commit b2bd0de into arduino:master Aug 4, 2020
@per1234 per1234 deleted the update-docs-workflow-references branch August 4, 2020 07:33
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants