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

Generate docs from CRD spec #325

Closed
VineethReddy02 opened this issue Jun 24, 2021 · 4 comments · Fixed by #505
Closed

Generate docs from CRD spec #325

VineethReddy02 opened this issue Jun 24, 2021 · 4 comments · Fixed by #505
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@VineethReddy02
Copy link
Contributor

Currently, we introduced a docs file for details on otelcol custom resource spec this needs to be manually maintained for all changes on CRD spec. So we should find an efficient way to generate the docs from CRD.
@VineethReddy02 VineethReddy02 mentioned this issue Jun 24, 2021
Merged
@jpkrohling jpkrohling added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jun 24, 2021
@paulfantom
Copy link

paulfantom commented Oct 23, 2021 •
edited
Loading

If anyone wants to tackle this, there is https://github.com/fybrik/crdoc for docs generation. Plus example usage in github.com/grafana/grafana-operator/pull/521.

@iblancasa
Copy link
Contributor

Hi! I would like to work on this issue if possible :)

@paulfantom
Copy link

@iblancasa go for it! 😄

@jpkrohling
Copy link
Member

It's yours, @iblancasa!

iblancasa added a commit to iblancasa/opentelemetry-operator that referenced this issue Nov 4, 2021
@iblancasa
Generate docs from CRD spec. Closes open-telemetry#325
3b9e378 
Signed-off-by: Israel Blancas <iblancas@redhat.com>
@paulfantom paulfantom mentioned this issue Nov 8, 2021
Closed
@iblancasa iblancasa mentioned this issue Nov 10, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate docs from CRD spec iblancasa/opentelemetry-operator
4 participants
@jpkrohling @paulfantom @iblancasa @VineethReddy02