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

Ensure the doctoc tool works #9114

Closed
killianmuldoon opened this issue Aug 3, 2023 · 3 comments · Fixed by #9112
Closed

Ensure the doctoc tool works #9114

killianmuldoon opened this issue Aug 3, 2023 · 3 comments · Fixed by #9112
Assignees
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@killianmuldoon
Copy link
Contributor

killianmuldoon commented Aug 3, 2023

Cluster API uses the doctoc tool to ensure a table of contents is generated for certain markdown files. It looks like the script and the make target it calls are not working correctly - at least with the version of doctoc I installed. It seems that it is not able to run doctoc against the set of files as passed in the script.

Additionally we should increase the number of files covered by this make target. Currently those markdown files are hardcoded. The hack/verify-doctoc.sh script should be updated so that it generates tables of contents correctly for all proposals in the CAPI repo - i.e all the markdown files in docs/proposals

c/f #9112 (comment)

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Aug 3, 2023
@sbueringer
Copy link
Member

/triage accepted

/help

@k8s-ci-robot
Copy link
Contributor

@sbueringer:
This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/triage accepted

/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 3, 2023
@killianmuldoon killianmuldoon changed the title Ensure the doctoc tool is run on all proposals Ensure the doctoc tool works Aug 3, 2023
@sbueringer
Copy link
Member

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants