TheThingsIndustries / lorawan-stack-docs

Documentation for The Things Stack
Apache License 2.0
32 stars 65 forks source link

Update the command-line interface documentation #733

Open ymgupta opened 2 years ago

ymgupta commented 2 years ago

Summary

The Enterprise CLI (tti-lw-cli) has additional commands for tenant management and OpenID Connect, which are not available with ttn-lw-cli. Currently, in the command-line interface documentation, the enterprise CLI (tti-lw-cli) commands are also documented to use with the open-source CLI ttn-lw-cli.

Why do we need this ?

To distinguish the commands available for the tti-lw-cliand ttn-lw-cli.

What is already there? What do you see now?

The Things Stack Open source command-line interface ttn-lw-cli documentation includes enterprise CLI commands. Ref: https://www.thethingsindustries.com/docs/reference/cli/

What is missing? What do you want to see?

A distinction should be made between open-source and enterprise CLI commands in the documentation.

How do you propose to document this?

  1. Update the overview of the CLI docs that it is the reference for both open source and enterprise CLI. Ref: https://www.thethingsindustries.com/docs/reference/cli/
  2. Create the command tree for enterprise CLI.

    Can you do this yourself and submit a Pull Request?

    No

nejraselimovic commented 2 years ago

I think this is automatically generated when updating docs after a TTS release, but I'm not so sure how that works so I'm gonna assign @benolayinka

KrishnaIyer commented 1 year ago

I'll pick this one up myself.