Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): simplify "Basic use" in README #3687

Merged
merged 1 commit into from
Sep 10, 2019
Merged

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented Sep 9, 2019

While working on #2480 and reviewing #2245, it occurred to me that "Basic use" in README of @loopback/cli is no longer basic, it looks more like a reference manual. It also requires extra maintenance whenever a new CLI command or a new option/argument is added.

In this pull request, I am proposing a radical simplification:

  • Describe the principles how to use our CLI tool
  • Show users how they can learn more about the commands and their options
  • Add a link to CLI reference where they can learn more.

You can view the rendered version of the newly proposed README here.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@bajtos bajtos added this to the Sept 2019 milestone milestone Sep 9, 2019
@bajtos bajtos requested a review from a team September 9, 2019 10:58
@bajtos bajtos requested a review from raymondfeng as a code owner September 9, 2019 10:58
@bajtos bajtos self-assigned this Sep 9, 2019
@bajtos bajtos force-pushed the refactor/cli-readme branch from 3a2da30 to 5f1c76f Compare September 9, 2019 11:00
Copy link
Contributor

@hacksparrow hacksparrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@derdeka
Copy link
Contributor

derdeka commented Sep 9, 2019

The rendered version contains:

This module contains the experimental CLI for LoopBack 4.

The the cli still experimental?

@bajtos
Copy link
Member Author

bajtos commented Sep 9, 2019

@derdeka Good catch! No, the CLI is no longer experimental :) Let me update the PR to fix that too.

@bajtos bajtos force-pushed the refactor/cli-readme branch from 5f1c76f to 3b63ff3 Compare September 9, 2019 14:18
@bajtos bajtos merged commit 3af74c1 into master Sep 10, 2019
@bajtos bajtos deleted the refactor/cli-readme branch September 10, 2019 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants