Meshery: [Docs] redesign mesheryctl Command Reference

[navendu-pottekkat]

Current State:

mesheryctl Command Reference is a central document which shows all the available mesheryctl commands and their usage.

Desired State:

However, the current page is not intuitive to the user and also misses documentation for some of the new commands added in mesheryctl.

The goal of the new design should be the following-

1. Improved mesheryctl Command Reference page that the users can refer to.
2. Links added to each of the commands which will point to the individual doc of each command.(individual docs are not added currently)

See user stories in the design spec for more info.

The following principles should be followed while designing and maintaining the document-

• Intuitive
  The document should be intuitive to the user. They should be able to easily understand the layout of the commands and should be able to easily check the subcommands and flags for each of the commands.

• Ease of access
  Each of the commands will have a separate documentation page and link to that page should be added to the corresponding command in the table.

Implementation:

• Improve the mesheryctl Command Reference page with inspiration from the mesheryctl Command Reference and Tracker doc.

The table should have the following columns-

1. command/arguments- The base command/argument
2. flag- Flags available for the given command
3. function- The function of the given command
4. usage- Example usage of the given command

• Add links in each entry in the table corresponding to a command which points to individual docs of the respective command (individual docs are not added currently).

---

Contributor Resources:

• Meshery documentation site
• Meshery documentation source
• Instructions for contributing to documentation
• mesheryctl Command Reference
• mesheryctl Command Reference and Tracker
• design spec- mesheryctl Command Reference

[navendu-pottekkat]

@alphaX86 all yours for the taking!

[alphaX86]

Well well, @navendu-pottekkat I accept! 😁👍

[alphaX86]

@navendu-pottekkat Am I supposed to create a separate table for system channel and system context?

[alphaX86]

I'm asking this to avoid issues, coz in sheet it's like that

[navendu-pottekkat]

It could be on the same table. Both of these will come under Meshery Lifecycle and Troubleshooting table.

[navendu-pottekkat]

That would be 5 tables in total. This is similar to the existing doc.

[alphaX86]

Okie, I did the Pattern configuration table and it looked good, but the validate command under mesh made one problem but I'm resolving it now

[navendu-pottekkat]

Nice! This doc is going to be referred a lot in the future. 🚀