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

Include CLI man pages on website #3915

Closed
tsandall opened this issue Oct 22, 2021 · 0 comments · Fixed by #4241
Closed

Include CLI man pages on website #3915

tsandall opened this issue Oct 22, 2021 · 0 comments · Fixed by #4241

Comments

@tsandall
Copy link
Member

tsandall commented Oct 22, 2021

Currently we do not have a comprehensive CLI reference on the website. This means that CLI users do not have an easy way to search for CLI options and examples when they want to do something new. Since we already generate man pages for the CLI, and the CLI descriptions contain examples and overviews of subcommands options, we could improve the situation (relatively easily) by generating HTML pages based on the CLI man pages. This was discussed in #3799. I am filing this issue to track the work as it's slightly more prescriptive about how to move forward.

CLI man pages were added by 4c81aa7. The tooling to generate the man pages have not changed since then. We should evaluate tools to generate HTML man pages and then integrate them into the docs/. To start, I'd like to see a single HTML page generated with subsections for each subcommand. The page can be called "CLI" and located under the "CORE DOCS" section of the website.

anderseknert added a commit to anderseknert/opa that referenced this issue Jan 19, 2022
Fixes open-policy-agent#3915

Signed-off-by: Anders Eknert <anders@eknert.com>
srenatus pushed a commit that referenced this issue Jan 19, 2022
Fixes #3915

Signed-off-by: Anders Eknert <anders@eknert.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant