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

chore(makefile): simplify api-docs generation #1551

Merged
merged 2 commits into from
May 23, 2024

Conversation

weisdd
Copy link
Collaborator

@weisdd weisdd commented May 22, 2024

In #1506, we've discovered that kustomization.yaml in config/ did not contain a reference to grafana.integreatly.org_grafanacontactpoints.yaml, thus the resource was not included in our generated documentation.
Essentially, that means that whenever we introduce new resources, we need not to forget to update kustomization.yaml. - In the current flow, we use kustomize to build a big yaml-file and then feed it to crdoc.

I suggest to have a bit simpler flow:
crdoc is smart enough to read all files from a folder, but, unfortunately, it fails with errors if a folder has any other files or nested folders.
To workaround that, we can simply have a separate folder that would only contain full CRDs and then point crdoc to that folder.

Copy link
Collaborator

@NissesSenap NissesSenap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@weisdd weisdd enabled auto-merge May 23, 2024 14:17
@weisdd weisdd merged commit 5286236 into master May 23, 2024
10 checks passed
@weisdd weisdd deleted the chore/simplify-api-docs-generation branch May 23, 2024 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants