wasuradananjith
commented
3 years ago When adding cross-references, we need to re-check the revamping of the descriptive doc space in [1]. Also, the apictl get keys command is only on page [2] not on any of the pages in [1].
[1] https://apim.docs.wso2.com/en/4.0.0/install-and-setup/setup/api-controller/getting-started-with-wso2-api-controller/ [2] https://apim.docs.wso2.com/en/4.0.0/install-and-setup/setup/api-controller/cicd-using-cli/#step-7-get-keys-for-an-apiapi-product
Description: Need to revisit and revalidate the APICTL catalog introduced in [1]. Since the catalog will have the descriptions about the flags of each command at an abstract level, cross-references should be there for each catalog command to point to the descriptive docs in [2].
For example, the catalog will have only apictl import and related flags to that. But what if someone wants to check apictl import api and its flags. The docs should have pointers to point to the descriptive docs in this kind of situations.
Affected Product Version: APICTL 4.0.0
[1] https://apim.docs.wso2.com/en/4.0.0/reference/apictl/wso2-api-controller/ [2] https://apim.docs.wso2.com/en/4.0.0/install-and-setup/setup/api-controller/getting-started-with-wso2-api-controller/