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

Updated Introduction by simplifying the writing #192

Merged
merged 3 commits into from
Jul 26, 2020
Merged

Updated Introduction by simplifying the writing #192

merged 3 commits into from
Jul 26, 2020

Conversation

ijlee2
Copy link
Member

@ijlee2 ijlee2 commented Jul 26, 2020

Description

I was reviewing what we mention in the CLI Guides with regards to the folder structure for an in-repo addon. On the long horizon, I'd like to document the colocated folder structure in Octane (this pertains to the issue #135).

As I review each section, if it's okay with the team, I'd like to update the section by simplifying the writing (the grammar). For example, in this PR, I preferred 2 short sentences instead of 1 joined by an "and" or a "which." I'm hoping that the result is a writing that is easier to parse and feels conversational when read out aloud.


The CLI comes with a command-line-based help system too. At any point, if you're curious what a command does and what the options are, you can add `--help` to the command and press enter to find out more.
For new users, the recommended learning path is to first do the Ember.js [Quickstart](https://guides.emberjs.com/release/getting-started/quick-start/) and [Tutorial](https://guides.emberjs.com/release/tutorial/). These teach the commands while building a sample app. Then, review the [Basic use](./basic-use) section of this site as a reference.
Copy link
Member Author

Choose a reason for hiding this comment

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

I added a link to the Basic use section.


The CLI comes with a help system too. At any point, if you're not sure what a command does and what its options are, you can add `--help` to the command and press enter to find out more.

```shell
Copy link
Member Author

Choose a reason for hiding this comment

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

I added an example of using --help.

guides/index.md Outdated Show resolved Hide resolved

## Getting help

Do you have questions? Run into an issue or a bug? Get support from the community. A list of chat rooms, forums, and more are available [here](https://www.emberjs.com/community/).
Did you have questions? Run into an issue or a bug? Get support from the community. A list of chat rooms, forums, and more is available on the [Community](https://www.emberjs.com/community/) page.
Copy link
Member Author

Choose a reason for hiding this comment

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

I changed "are" to "is" and provided a descriptive information for the link ("here" is, in general, discouraged, I believe).

@ijlee2 ijlee2 marked this pull request as ready for review July 26, 2020 15:41
@ijlee2 ijlee2 requested a review from a team July 26, 2020 15:41
Copy link
Contributor

@rwjblue rwjblue left a comment

Choose a reason for hiding this comment

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

Nice bit of cleanup here @ijlee2!

guides/index.md Outdated Show resolved Hide resolved
@ijlee2 ijlee2 merged commit e573a28 into ember-learn:master Jul 26, 2020
@ijlee2 ijlee2 deleted the update-introduction branch July 26, 2020 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants