Skip to content

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

@LiZhenCheng9527

Description

@LiZhenCheng9527

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.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions