Skip to content

fix(@angular/cli): Adding more details to documentation #4960

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 6, 2017
Merged

fix(@angular/cli): Adding more details to documentation #4960

merged 1 commit into from
Mar 6, 2017

Conversation

sumitarora
Copy link
Contributor

@sumitarora sumitarora commented Feb 23, 2017 •
edited
Loading

  • Added descriptions to .md files now both are similar on ng help and docs.
  • Ordered options in alphabetical order

@sumitarora sumitarora force-pushed the feat-documentation branch 2 times, most recently from ccd7ddd to cffb06c Compare February 23, 2017 16:25
@sumitarora sumitarora changed the title fix(@angulat/cli): Adding more details to documentation fix(@angular/cli): Adding more details to documentation Feb 23, 2017
filipesilva
filipesilva suggested changes Feb 23, 2017
View reviewed changes
Copy link
Contributor

@filipesilva filipesilva left a comment

Choose a reason for hiding this comment

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

Two little changes please. Awesome work getting all these detailed!

docs/documentation/e2e.md Outdated
@@ -14,16 +14,72 @@ ng e2e
End-to-end tests are run via [Protractor](https://angular.github.io/protractor/).

## Options
`--aot` Build using Ahead of Time compilation.
Copy link
Contributor

Choose a reason for hiding this comment

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

e2e inherits options from serve, can you list just the e2e specific options (the ones in the command file) and refer to the serve command for the rest?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

docs/documentation/serve.md Outdated
@@ -6,54 +6,62 @@
`ng serve` builds the application and starts a web server

## Options
`--watch` (`-w`) rebuild when files change
`--aot` Build using Ahead of Time compilation.
Copy link
Contributor

Choose a reason for hiding this comment

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

serve inherits options from build, can you list just the serve specific options and refer to the build command for the rest?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

filipesilva
filipesilva suggested changes Feb 23, 2017
View reviewed changes
docs/documentation/e2e.md Outdated
@@ -16,14 +16,10 @@ End-to-end tests are run via [Protractor](https://angular.github.io/protractor/)
## Options
`--config` (`-c`) use a specific config file. Defaults to the protractor config file in `.angular-cli.json`.

`--specs` (`-sp`) override specs in the protractor config.
Can send in multiple specs by repeating flag (`ng e2e --specs=spec1.ts --specs=spec2.ts`).
`--proxy-config` (`-pc`) Proxy configuration file.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is part of the serve options, it doesn't need to be here.

docs/documentation/e2e.md Outdated

`--element-explorer` (`-ee`) start Protractor's
Copy link
Contributor

Choose a reason for hiding this comment

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

This should still be listed.

docs/documentation/e2e.md Outdated
`--element-explorer` (`-ee`) start Protractor's
[Element Explorer](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively)
for debugging.
`--serve` Compile and Serve the app. All non-reload related serve options are also available (e.g. --port=4400).
Copy link
Contributor

Choose a reason for hiding this comment

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

The live-reload options are still available, it's just that it defaults to false.

docs/documentation/serve.md Outdated
`--output-hashing` define the output filename cache-busting hashing mode

`--poll` enable and define the file watching poll time period (milliseconds)
`--ssl-key` SSL key to use for serving HTTPS.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you mention that all the build options are still here, except for stats-json?

Brocco
Brocco reviewed Feb 23, 2017
View reviewed changes
docs/documentation/config.md Outdated
# ng set

## Overview
`ng set [key]` Set a value in the configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this show the value too?
ng set [key] [value]

@sumitarora sumitarora force-pushed the feat-documentation branch 2 times, most recently from d8e690f to 2bc8565 Compare February 24, 2017 15:51
@sumitarora sumitarora mentioned this pull request Feb 27, 2017
Closed
@sumitarora sumitarora mentioned this pull request Mar 3, 2017
Closed
@sumitarora sumitarora force-pushed the feat-documentation branch from 8f78b03 to 1c5192f Compare March 3, 2017 16:21
@sumitarora
Copy link
Contributor Author

@hansl @filipesilva This can be merged to master unless there are more changes needed.

filipesilva
filipesilva suggested changes Mar 6, 2017
View reviewed changes
Copy link
Contributor

@filipesilva filipesilva left a comment

Choose a reason for hiding this comment

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

Just this more change please!

docs/documentation/e2e.md Outdated
`--element-explorer` (`-ee`) start Protractor's
[Element Explorer](https://github.com/angular/protractor/blob/master/docs/debugging.md#testing-out-protractor-interactively)
for debugging.
`--serve` Compile and Serve the app. All non-reload related serve options are also available (e.g. --port=4400). The live-reload option defaults to false.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please change this to:

`--serve` Compile and Serve the app. All serve options are also available. The live-reload option defaults to false, and the default port will be random.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@sumitarora sumitarora force-pushed the feat-documentation branch from 1c5192f to ca3dfa2 Compare March 6, 2017 15:25
@sumitarora sumitarora force-pushed the feat-documentation branch from ca3dfa2 to 8e1973a Compare March 6, 2017 15:26
@filipesilva filipesilva merged commit 8c3a7b8 into angular:master Mar 6, 2017
@filipesilva
Copy link
Contributor

Thanks for all the work in this Pr @sumitarora!

@filipesilva filipesilva mentioned this pull request Mar 9, 2017
Closed
2 tasks
@sumitarora sumitarora deleted the feat-documentation branch March 24, 2017 16:35
asnowwolf pushed a commit to asnowwolf/angular-cli that referenced this pull request Apr 12, 2017
@sumitarora
docs(@angular/cli): Adding more details to documentation (angular#4960)
6aead89
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Brocco Brocco Brocco left review comments

@filipesilva filipesilva filipesilva approved these changes

@hansl hansl Awaiting requested review from hansl

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sumitarora @filipesilva @Brocco @googlebot