Skip to content
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

Add versioning to docs #711

Merged
merged 8 commits into from
May 21, 2020
Merged

Add versioning to docs #711

merged 8 commits into from
May 21, 2020

Conversation

masci
Copy link
Contributor

@masci masci commented May 18, 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?

This PR introduces Mike to wrap Mkdocs execution so that we can build different docs for each different Arduino CLI version.

  • What is the current behavior?

At the moment docs are built and published at every merge on master, meaning that the docs might contain unreleased features.

  • What is the new behavior?

We'll add:

  • a special latest version of the docs pointing to the most recent Arduino CLI release: these docs will be shown by default when landing to https://arduino.github.io/arduino-cli/

  • a special dev version of the docs, documenting whatever we have on master at every commit

  • a selector to pick the right version of the docs for the Arduino CLI version users have installed

  • Does this PR introduce a breaking change?

No, existing docs will be preserved, new ones will follow the versioning strategy.

  • Other information:

See how to contribute

@masci masci added the status: in progress Work is in progress on this label May 18, 2020
@masci masci added topic: documentation Related to documentation for the project component/tooling and removed status: in progress Work is in progress on this labels May 20, 2020
env:
REMOTE: https://x-access-token:${{secrets.GITHUB_TOKEN}}@github.com/${{github.repository}}.git

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An unwanted blank line maybe?

Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

@masci masci merged commit 70c6205 into master May 21, 2020
@masci masci deleted the massi/mike branch May 21, 2020 09:21
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