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

Generate / publish API docs for airshipctl api documents #593

Open
seaneagan opened this issue Jun 25, 2021 · 2 comments
Open

Generate / publish API docs for airshipctl api documents #593

seaneagan opened this issue Jun 25, 2021 · 2 comments
Assignees
Labels
enhancement New feature or request priority/medium Default priority for items size m
Milestone

Comments

@seaneagan
Copy link
Contributor

Problem description (if applicable)

It would be useful to have autogenerated api documentation for the airshipctl API documents.

Proposed change

Once we are generating CRDs for all of the airshipctl API types (#574), we can use those to generate / publish api docs,
similar to how we are doing this in sip and vino:
https://github.com/airshipit/sip/blob/master/docs/api/sipcluster.md
https://github.com/airshipit/vino/blob/master/docs/api/vino.md

Once we get the generation in place we could look at publishing airshipctl/sip/vino docs all to https://docs.airshipit.org/

@seaneagan seaneagan added enhancement New feature or request triage Needs evaluation by project members labels Jun 25, 2021
@seaneagan
Copy link
Contributor Author

@seaneagan seaneagan self-assigned this Jun 25, 2021
@jezogwza jezogwza added priority/medium Default priority for items and removed triage Needs evaluation by project members labels Jul 14, 2021
@jezogwza jezogwza added this to the v2.1 milestone Jul 14, 2021
@eak13 eak13 added the size m label Jul 26, 2021
@lb4368 lb4368 modified the milestones: v2.1, Future Oct 27, 2021
@sanjib-35
Copy link

please assign to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority/medium Default priority for items size m
Projects
None yet
Development

No branches or pull requests

5 participants