Skip to content

Commit

Permalink
Split CRD documentation into separate files (#3696)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
swiatekm authored Feb 6, 2025
1 parent 3c8f286 commit 42fed3b
Show file tree
Hide file tree
Showing 7 changed files with 68,708 additions and 68,658 deletions.
9 changes: 7 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -625,8 +625,13 @@ api-docs: crdoc kustomize
cp -r config/crd/* $$TMP_MANIFEST_DIR; \
$(MAKE) CRD_OPTIONS=$(CRD_OPTIONS),maxDescLen=1200 MANIFEST_DIR=$$TMP_MANIFEST_DIR/bases manifests ;\
TMP_DIR=$$(mktemp -d) ; \
$(KUSTOMIZE) build $$TMP_MANIFEST_DIR -o $$TMP_DIR/crd-output.yaml ;\
$(CRDOC) --resources $$TMP_DIR/crd-output.yaml --output docs/api.md ;\
$(KUSTOMIZE) build $$TMP_MANIFEST_DIR -o $$TMP_DIR ;\
mkdir -p docs/api ;\
for crdmanifest in $$TMP_DIR/*; do \
filename="$$(basename -s .opentelemetry.io.yaml $$crdmanifest)" ;\
filename="$${filename#apiextensions.k8s.io_v1_customresourcedefinition_}" ;\
$(CRDOC) --resources $$crdmanifest --output docs/api/$$filename.md ;\
done;\
}


Expand Down
Loading

0 comments on commit 42fed3b

Please sign in to comment.