Add template workflow to generate Cobra docs and deploy a versioned MkDocs-based website to GitHub Pages #88
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
type: enhancement
These are the unmodified files from Arduino Lint: - https://github.com/arduino/arduino-lint/blob/187ff138536f9decb2b049545f4a359cf22781dc/docsgen/go.mod - https://github.com/arduino/arduino-lint/blob/187ff138536f9decb2b049545f4a359cf22781dc/docsgen/main.go - https://github.com/arduino/arduino-lint/blob/187ff138536f9decb2b049545f4a359cf22781dc/Taskfile.yml (relevant task)
…templates The source content for the template files were from Arduino Lint, and contained references specific to Arduino Lint. These were replaced by placeholders, or in the case of comments, the wording made universal.
There may be project-specific documentation generation. The most prominent is the command line reference generation for projects using Cobra. Another is Arduino CLI's gRPC interface documentation. These project-specific generations should have dedicated tasks with appropriate names. A single umbrella task is used to run all the documentation generation tasks the project has. This umbrella task uses a standardized name: `docs:generate`. In this manner, the templates can be configured to be general purpose and work for all projects without requiring significant changes to account for the specifics of their documentation generation requirements. In the event the project does not generate any documentation content, the task can simply be left empty.
…kDocs-based website to GitHub Pages
On every push to the repository's default branch or release branch, generate a command line reference and deploy the
repository's MkDocs-based static website to GitHub Pages.
Documentation content will sometimes apply only to a specific version of the project. For this reason, it's important
for the reader to be able to access the documentation for the specific version of the project they are using.
The documentation system provides access to:
- The tip of the default branch ("dev")
- The latest release ("latest")
- Each minor version series (e.g., "1.2")
The website version is selectable via a menu on the website as well as the URL of each documentation page.
---
This workflow is based on the "Deploy Website" workflow (versioned, MkDocs, Poetry) template.
umbynos
approved these changes
Jul 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On every push to the repository's default branch or release branch, generate a command line reference and deploy the
repository's MkDocs-based static website to GitHub Pages.
Documentation content will sometimes apply only to a specific version of the project. For this reason, it's important
for the reader to be able to access the documentation for the specific version of the project they are using.
The documentation system provides access to:
The website version is selectable via a menu on the website as well as the URL of each documentation page.
This workflow is based on the "Deploy Website" workflow (versioned, MkDocs, Poetry) template and on the command line reference generation system from Arduino Lint.
I went through the installation process for this and the other affected template workflows ("Check Markdown", "Check Website") in my fork of Arduino Lint: