Auto-generate CRD Documentation #1342
Comments
|
This issue is marked as stale due to inactivity. Add a new comment to reactivate it. |
|
The generated output can be saved into a file named |
|
This issue is marked as stale due to inactivity. Add a new comment to reactivate it. |
|
@ihcsim I am willing to contribute, can I take it up? |
|
Hey @Kartik-Garg, |
|
Hey @PrasadG193 , I have created the PR : #1727 |
|
This issue is marked as stale due to inactivity. Add a new comment to reactivate it. |
|
This issue is closed due to inactivity. Feel free to reopen it, if it's still relevant. |
|
@PrasadG193 @ihcsim @viveksinghggits Can we get this issue reopened please, work on PR is completed and it's updated. |
* created documentation * Auto-generation of API CRD documentation Added the command in make docs now so when make docs command is ran, the API CRD documentation is also created automatically with "API.md" name, created a folder called template which contains all the necessary files (template files, place-holder go file, json file and executable binary file) which are used/needed in the creating of the API CRD documentation Signed-off-by: Kartik-Garg <[email protected]> * Auto-Generation of API CRD documentation Added the command in make docs now so when make docs command is ran, the API CRD documentation is also created automatically with "API.md" name, created a folder called template which contains all the necessary files (template files, place-holder go file, json file and executable binary file) which are used/needed in the creating of the API CRD documentation Signed-off-by: Kartik-Garg <[email protected]> * Deleting the directory * adding template folder for internal PR * Update Makefile Co-authored-by: kale-amruta <[email protected]> * Modifying dokcer build image Added tool to create CRD documentation to the docker build file, so we dont have to explicitly add exec binary to our project Signed-off-by: Kartik-Garg <[email protected]> * Removing executable binary and json from template folder As per the suggestion from the PR comment, removed executable binary from this folder, also removed .json file which was not required Signed-off-by: Kartik-Garg <[email protected]> * Changes in makefile Added a new target for creating on crd documentaion called as crd_docs and also added new command for it which is run inside the container image build Signed-off-by: Kartik-Garg <[email protected]> * Update Makefile Removed unwanted space Co-authored-by: Prasad Ghangal <[email protected]> * Update Makefile Improved the spacing as per the suggestion. Co-authored-by: Prasad Ghangal <[email protected]> * Making it more tidy Removed the template folder, updated API.md file, Made alignment changes Signed-off-by: Kartik-Garg <[email protected]> * Modifying makefile alignement Modified space in makefile Signed-off-by: Kartik-Garg <[email protected]> * Made changes in the Dockerfile build and makfile Added new required files for the API CRD documentation tool and made changes in the docker build and the makefile command to run the target to generate the documentation. Changed config file name. Signed-off-by: Kartik-Garg <[email protected]> * Changes in CONTRIBUTING.md Added steps to create the documentation when changes are made in Kanister API Types as well. Signed-off-by: Kartik-Garg <[email protected]> --------- Signed-off-by: Kartik-Garg <[email protected]> Signed-off-by: Kartik-Garg <[email protected]> Co-authored-by: kale-amruta <[email protected]> Co-authored-by: Prasad Ghangal <[email protected]>
Use a tool like https://github.com/ahmetb/gen-crd-api-reference-docs/ to auto-generate the CRD documentation, to avoid deviation between the code and the doc. Update the Makefile
docstarget to include the new command.The text was updated successfully, but these errors were encountered: