capsule icon indicating copy to clipboard operation
capsule copied to clipboard

Added makefile command to autogen CRDs documentation

Open mastrogiovanni opened this issue 2 years ago • 3 comments

I added a Makefile command to create a reference.md file into docs starting from CRDs from config/crd/base. The tool chosen is a result of several trials since:

  • standard kubernetes tools requires connection to API Server
  • stardard kubernetes reference libraries works with openAPIv2 but not v3 (that is incomplete)
  • other tools (in python) ones seems incomplete and buggy and can introduce some problem in maintenance of the codebase
  • the tool chosen seems to belong to a cloud native platform with a good track record

mastrogiovanni avatar Aug 03 '22 07:08 mastrogiovanni

Deploy Preview for capsule-documentation ready!

Name Link
Latest commit ffb04c3d722533d12c87ea4c866fab702ba0dc4a
Latest deploy log https://app.netlify.com/sites/capsule-documentation/deploys/62f4235504ac810008285d8f
Deploy Preview https://deploy-preview-629--capsule-documentation.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Aug 03 '22 07:08 netlify[bot]

I reset the references.md file to the old version and I just added the newly generated tenantCRDMarkdown.md to the PR. Not clear to me if references.md need to be autogenerated or not. I think that having a section for CRD and another for the rest is the best strategy.

mastrogiovanni avatar Aug 05 '22 14:08 mastrogiovanni

I think that having a section for CRD and another for the rest is the best strategy.

Absolutely, let's remove the CRD scheme from docs/content/general/references.md file, pointing with a link to the new file.

Remember to add it to the side menu, suddenly after References with the title APIs.

prometherion avatar Aug 06 '22 15:08 prometherion

The output rendered is not so superb: https://deploy-preview-629--capsule-documentation.netlify.app/docs/general/tenant-crd#capsuleconfiguration.

Could we try to customize it a bit, by removing the ↩ Parent link?

prometherion avatar Aug 10 '22 12:08 prometherion

I customized the template that originate the page and added some styling to improve table readibility

mastrogiovanni avatar Aug 10 '22 21:08 mastrogiovanni