cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Added asciidoc generation and associated tests.

Open bovinemagnet opened this issue 2 years ago • 7 comments

Added Asciidoc as a generation target for documentation.

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

bovinemagnet avatar May 17 '22 14:05 bovinemagnet

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[bot] avatar May 17 '22 14:05 github-actions[bot]

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar May 17 '22 14:05 CLAassistant

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
----

bovinemagnet avatar May 17 '22 14:05 bovinemagnet

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[bot] avatar May 26 '22 07:05 github-actions[bot]

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[bot] avatar May 26 '22 07:05 github-actions[bot]

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

bovinemagnet avatar May 26 '22 07:05 bovinemagnet

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.

github-actions[bot] avatar Sep 07 '22 00:09 github-actions[bot]