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

Split CRD documentation into separate files #3696

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

swiatekm
Copy link
Contributor

@swiatekm swiatekm commented Feb 5, 2025

Description:
The CRD API doc became unmanagably large with the addition of TargetAllocators, and can't even be rendered by Github's markdown viewer. Split it into separate files per CRD.

The shell code to produce this is a bit hacky, but I'd like to merge it to resolve the problem first, and refine it a bit later.

Link to tracking Issue(s):

The CRD API doc became unmanagably large with the addition of
TargetAllocators, and can't even be rendered by Github's markdown viewer
. Split it into separate files per CRD.
@swiatekm swiatekm requested a review from a team as a code owner February 5, 2025 20:43
@swiatekm swiatekm added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to view docs/api.md in GitHub Web
1 participant