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

built-in documentation for Linux package #1240

Open
qrkourier opened this issue Aug 9, 2023 · 3 comments
Open

built-in documentation for Linux package #1240

qrkourier opened this issue Aug 9, 2023 · 3 comments

Comments

@qrkourier
Copy link
Member

Install a user manual (man) for each Linux package after they're available in #911

plorenz added a commit that referenced this issue Sep 28, 2023
…om/openziti/fabric-0.21.20

Bump github.com/openziti/fabric from 0.21.17 to 0.21.20
@qrkourier
Copy link
Member Author

Needed:

  • man 1 openziti user manual
  • man 8 openziti-controller sysadmin manual
  • man 8 openziti-router sysadmin manual

@qrkourier
Copy link
Member Author

Have you already discussed this, @plorenz, @ekoby, or @scareything? I've read plenty of man pages but have yet to write any. 🙂

The man page for the ziti CLI is an opportunity to be extremely helpful and valuable to the server administrator with built-in, authoritative documentation.

As for tooling, I like the idea of maintaining Markdown manuals in the main Ziti repo that are automatically translated to man pages for each Linux package. This will be nicer for the maintainers because only one set of authoritative docs is needed, and it's probably a simple matter to convert the formats and lint the output in CI. I'll happily help with that last part and maintain the documentation sources.

Ideally, we'll use the same tools and approach for this user manual and the one for zrok.

@plorenz
Copy link
Member

plorenz commented Jan 11, 2024

The markdown -> man approach seems nice

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants