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

Unable to view docs/api.md in GitHub Web #3681

Closed
CharlieTLe opened this issue Jan 29, 2025 · 3 comments · Fixed by #3696
Closed

Unable to view docs/api.md in GitHub Web #3681

CharlieTLe opened this issue Jan 29, 2025 · 3 comments · Fixed by #3696
Assignees
@swiatekm

Comments

@CharlieTLe
Copy link

Unable to view docs/api.md in GitHub Web

https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#opentelemetrycollector

(Sorry about that, but we can’t show files that are this big right now.)
@CharlieTLe
Copy link
Author

Seems to have been caused by 1a0a729#diff-9eddf4dc51bf6a0125ca7fb094468ad284112270385c41cebce4f8f0a29620ab

Last working is https://github.com/open-telemetry/opentelemetry-operator/blob/05900573bfbc0e97e545fcad13d606f3b13473ef/docs/api.md.

@CharlieTLe
Copy link
Author

It's possible to use something like https://pandoc.org to generate the HTML from the markdown file.

$ pandoc docs/api.md -f gfm -t html -o api.html

@CharlieTLe CharlieTLe mentioned this issue Jan 29, 2025
Closed
@swiatekm
Copy link
Contributor

We've discussed this during a recent SIG meeting, and a simple solution is to split this file per CRD. I'll assign this to myself, since I already have a working prototype.

@swiatekm swiatekm self-assigned this Jan 29, 2025
@swiatekm swiatekm mentioned this issue Feb 5, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@swiatekm swiatekm

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Split CRD documentation into separate files swiatekm/opentelemetry-operator
2 participants
@CharlieTLe @swiatekm