Add toc generation and validation to VPA#8993
Conversation
k8s-ci-robot
added
release-note-none
k8s-ci-robot
added
the
size/L
Also add some TOC markers to existing markdown files, and run generate-toc on them
adrianmoisey
force-pushed
the
add-toc-automation
branch
from
c3ee418 to
8f39598
Compare
| ./MIGRATE.md | ||
| ./charts/vertical-pod-autoscaler/README.md | ||
| ./charts/README.md | ||
| ./docs/api.md |
There was a problem hiding this comment.
I think it's possible to generate this api.md file with a top, but I didn't want to fall down that rabbit hole
| ./charts/vertical-pod-autoscaler/README.md | ||
| ./charts/README.md |
There was a problem hiding this comment.
We could easily add a toc to the chart readme, what do you think @omerap12
There was a problem hiding this comment.
Can you add this to this PR so we can see how it would look like?
There was a problem hiding this comment.
I gave it a test, part of the problem is that some of the headings are generated by helm-docs
So the toc generation tool will conflict with the helm-docs generation
There was a problem hiding this comment.
Got it. so let's keep it that way.
There was a problem hiding this comment.
Yeah, I'm hoping that norwoodj/helm-docs#288 is done one day
omerap12
left a comment
omerap12
left a comment
There was a problem hiding this comment.
/lgtm
/approve
/hold
in case you don't want to merge this.
k8s-ci-robot
added
the
do-not-merge/hold
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: adrianmoisey, omerap12 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Thanks! |
k8s-ci-robot
removed
the
do-not-merge/hold
3 participants
What type of PR is this?
/kind cleanup
What this PR does / why we need it:
Adds the
sigs.k8s.io/mdtoctool to the VPA so that tocs are verified and generatedWhich issue(s) this PR fixes:
N/A
Special notes for your reviewer:
This is copied from https://github.com/kubernetes/enhancements/
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: