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

Added asciidoc generation and associated tests. #1698

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

bovinemagnet
Copy link

Added Asciidoc as a generation target for documentation.

Based off the markdown, additional tests are added to ensure the nested file generation.

@github-actions github-actions bot added the area/docs-generation Generation of docs via Cobra label May 17, 2022
@github-actions
Copy link

This PR exceeds the recommended size of 200 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions github-actions bot added the size/XL Denotes a PR that exceeds 200 lines. Caution! label May 17, 2022
@CLAassistant
Copy link

CLAassistant commented May 17, 2022

CLA assistant check
All committers have signed the CLA.

@bovinemagnet
Copy link
Author

This change makes use of the following AsciiDoc elements (that differ from a straight MD to AsciiDoc type approach).

Also see uses xref: to make it compatible with github asciidocs, Antora asciidocs, and asciidoc-pdf generation.

The initial heading is set to level = to ensure it will not cause parsing errors with Antora (as apposed to the example which would have made it ==).

All options are wrapped in "text" source blocks, and given a title for the source block, such as:

.Option Title
[source,text]
----
  -h, --help   help for command
----

@github-actions
Copy link

This PR exceeds the recommended size of 200 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@github-actions
Copy link

This PR exceeds the recommended size of 200 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

@bovinemagnet
Copy link
Author

I removed the licence that I accidentally copied into the header of the file. to address the concerns of @jpmcb

@github-actions
Copy link

github-actions bot commented Sep 7, 2022

The Cobra project currently lacks enough contributors to adequately respond to all PRs. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the PR is closed.
    You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If a PR has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening.

@jpmcb jpmcb added lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten and removed lifecycle/stale labels Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs-generation Generation of docs via Cobra lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten size/XL Denotes a PR that exceeds 200 lines. Caution!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants