Skip to content

Conversation

@i3mSuperMan
Copy link

Summary

Improvized the CLI installation guide with instructions for the three platforms Linux, macOS & Windows.

Changes

  • Changed the documentation structure with separate tabs containing installation steps to be performed in Linux, Windows, and macOS.
  • Added steps to install CLI in windows.
  • Re-organized the Configuration & Generate configuration file sections.
  • Reason for this is we will generate a configuration file first and then configure the CLI
  • Added note to get the cloud-hosted address for CLI configuration.

Notes for Reviewers

Internal Note to @trnkrishna
I am not 100% sure about the Configuring CLI section in the three platforms. Need your advice in this regard.

  • Which set/export command work in each platform?

Checklist

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@i3mSuperMan i3mSuperMan added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Feb 8, 2021
@i3mSuperMan i3mSuperMan self-assigned this Feb 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants