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

Spike: explore documentation solutions #59

Open
2 tasks done
jpmcb opened this issue Oct 26, 2023 · 3 comments
Open
2 tasks done

Spike: explore documentation solutions #59

jpmcb opened this issue Oct 26, 2023 · 3 comments

Comments

@jpmcb
Copy link
Member

jpmcb commented Oct 26, 2023

Type of feature

🍕 Feature

Current behavior

There aren't really great docs around the CLI

Suggested solution

  1. We should generate man pages for the CLI

  2. We should explore documentation solutions for the CLI: an easy quick win would be using a GitHub wiki. But we may integrate latter into the open-sauced docs or deploy our own docusaurus site.

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@jpmcb
Copy link
Member Author

jpmcb commented Oct 26, 2023

cc @BekahHW - do you have any thoughts on this? The docs should be pretty lite and relatively structured. A good example is some of the kubectl docs:

https://kubernetes.io/docs/reference/kubectl/

@BekahHW
Copy link
Member

BekahHW commented Oct 26, 2023

I think it should go in our main docs repo.

The goal is to move away from contributor resources that aren't necessary for using our product and focus on the product.

@jpmcb jpmcb self-assigned this Oct 26, 2023
@jpmcb
Copy link
Member Author

jpmcb commented Oct 26, 2023

Cool cool, I can look at adding those soon

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

No branches or pull requests

2 participants