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.

Sign up for GitHub

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

Jump to bottom

[DOC] Auto Update Config Docs #243

Closed
beeme1mr opened this issue Jan 3, 2023 · 0 comments · Fixed by #305
Closed

[DOC] Auto Update Config Docs #243

beeme1mr opened this issue Jan 3, 2023 · 0 comments · Fixed by #305
Assignees
@skyerus
Labels
documentation Improvements or additions to documentation

Comments

@beeme1mr
Copy link
Member

beeme1mr commented Jan 3, 2023

Change in the documentation

The configuration documentation is currently manually maintained. This can be automated in Cobra by using the generator markdown command. Automatic updates will ensure that the docs always reflect the latest configuration options.
@beeme1mr beeme1mr added the documentation Improvements or additions to documentation label Jan 3, 2023
@skyerus skyerus self-assigned this Jan 23, 2023
@skyerus skyerus mentioned this issue Jan 23, 2023
Merged
skyerus added a commit that referenced this issue Jan 24, 2023
@skyerus @beeme1mr
chore: auto update config docs (#305)
7d24060 
## This PR
<!-- add the description of the PR here -->

- Introduced `make generate-docs` which auto generates cmd config
documentation
- Pipeline check that doc generation doesn't create a diff (fail if it
does with a message to run `make generate-docs`)

### Related Issues
<!-- add here the GitHub issue that this PR resolves if applicable -->

Fixes #243 

### Notes
<!-- any additional notes for this PR -->

### Follow-up Tasks
<!-- anything that is related to this PR but not done here should be
noted under this section -->
<!-- if there is a need for a new issue, please link it here -->

### How to test
<!-- if applicable, add testing instructions under this section -->

Signed-off-by: Skye Gill <gill.skye95@gmail.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skyerus skyerus

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: auto update config docs skyerus/flagd
2 participants
@beeme1mr @skyerus