[Docs] Revisit the API Controller Catalog
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
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/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the APICTL catalog at the reference URL with the descriptive API Controller documentation linked in the issue. Revalidate each catalog command and add cross-references for command variants and flags where needed; the work is done when every catalog entry points readers to its relevant descriptive documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100