Skip to content

Sync documentation assets with templates #104

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 16, 2021
Merged

Sync documentation assets with templates #104

merged 1 commit into from
Aug 16, 2021

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Aug 14, 2021

We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These assets will be used in the repositories of all Arduino tooling projects.

Some significant improvements and standardizations have been made in the upstream "template" website assets, and those
are introduced to this repository here.

Notable:

  • Streamline website versioning system
  • Update website dependencies
  • Bump Python version used by the workflow from 3.8 to 3.9

Some tasks have changed:

  • docs:gen:commands -> go:cli-docs
  • docs:publish -> removed

Demo "dev" deployment from my fork:

Demo "2.1" deployment from my fork:

The link check failure is expected and will be fixed after the first run of the new workflow. Equivalent URL from my fork:
https://github.com/per1234/arduino-fwuploader/actions/workflows/deploy-cobra-mkdocs-versioned-poetry.yml/badge.svg

@per1234 per1234 added type: enhancement Proposed improvement topic: infrastructure Related to project infrastructure topic: documentation Related to documentation for the project labels Aug 14, 2021
@per1234 per1234 requested a review from umbynos August 14, 2021 07:34
We have assembled a collection of reusable project assets:
https://github.com/arduino/tooling-project-assets
These assets will be used in the repositories of all Arduino tooling projects.

Some significant improvements and standardizations have been made in the upstream "template" website assets, and those
are introduced to this repository here.

Notable:

- Streamline website versioning system
- Update website dependencies
- Bump Python version used by the workflow from 3.8 to 3.9

Some tasks have changed:

- `docs:gen:commands` -> `go:cli-docs`
- `docs:publish` -> removed
@per1234 per1234 merged commit 685578a into arduino:main Aug 16, 2021
@per1234 per1234 deleted the sync-website branch August 16, 2021 10:48
@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 topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants