chore(makefile): simplify api-docs generation #1551
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #1506, we've discovered that
kustomization.yaml
inconfig/
did not contain a reference tografana.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 usekustomize
to build a big yaml-file and then feed it tocrdoc
.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.