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

Modify github.com/ahmetb/gen-crd-api-reference-docs so that it retains the leading space of the yaml example in the comments. #522

Open
LiZhenCheng9527 opened this issue Dec 19, 2023 · 2 comments
Assignees

Comments

@LiZhenCheng9527
Copy link
Contributor

What would you like to be added:
Fork the github.com/ahmetb/gen-crd-api-reference-docs project into the kurator project and modify it so that it retains the leading spaces in YAML examples when generating API documentation.

Why is this needed:
Kurator's API has many YMAL examples. However, github.com/ahmetb/gen-crd-api-reference-docs does not support preserving leading spaces, resulting in problematic indentation of the yaml examples. To keep the documentation correct, Kurator should ensure that the YAML examples in the documentation are correct. Or we will try to change the API doc generation tool.

@LiZhenCheng9527
Copy link
Contributor Author

/assign @LiZhenCheng9527

@hzxuzhonghu
Copy link
Member

cc @zirain maybe you have some other solutions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants