Docs preview #12837

jbogarthyde · 2018-11-01T16:27:49Z

new and edited doc for commands and subcommands (from PRs #12741 and #12743)

…into docs-preview

…docs-preview

alan-agius4 · 2018-11-02T08:23:26Z

packages/angular/cli/commands/build-long.md

 Resources in CSS, such as images and fonts, are automatically written and fingerprinted at the root of the output folder.

-Uses the Webpack build tool, with environment and build options specified in the CLI configuration file.
+For further details, see Workspace Configuration.


Maybe we should add a link?

The new page just landed - adding link here, and another one in config.

alan-agius4 · 2018-11-02T08:24:45Z

packages/schematics/angular/library/library-long.md

+A library is a type of project that does not run independently.
+The library skeleton created by this command is placed by default in the `/projects` folder, and has `type` of "library".
+
+You can build a new library using the `ng build` command, and unit-test it and lint it using the `ng test` and `ng lint` commands.


Note quite sure about the grammar here, and unit-test it and lint it

Maybe something like;

You can build the library, unit-test and lint it using the ng build, ng test and ng lint commands respectively.

jenniferfell

No show stoppers. Mostly just impressions from a first-time reader and a few typos.

jenniferfell · 2018-11-02T18:25:16Z

packages/angular/cli/commands/build-long.md

@@ -1,3 +1,14 @@
+Uses the Webpack build tool, with default configuration options specified in the workspace configuration file, `angular.json`, or with a named alternative configuration. 


Edit: Looks like "webpack" uses lowercase for themselves: https://webpack.js.org/concepts/

jenniferfell · 2018-11-02T18:26:16Z

packages/angular/cli/commands/build-long.md

@@ -1,3 +1,14 @@
+Uses the Webpack build tool, with default configuration options specified in the workspace configuration file, `angular.json`, or with a named alternative configuration. 


Edit: Comma thing. Could be misread as 3 things. Maybe this: "Uses the Webpack build tool, with default configuration options specified in the workspace configuration file (angular.json) or with a named alternative configuration.

jenniferfell · 2018-11-02T18:28:19Z

packages/angular/cli/commands/definitions.json

          "type": "string",
          "aliases": [
            "c"
          ]
        },
        "prod": {
-          "description": "When true, sets the build configuration to the production environment.\nAll builds make use of bundling and limited tree-shaking, A production build also runs limited dead code elimination using UglifyJS.",
+          "description": "When true, sets the build configuration to the production target.\nAll builds make use of bundling and limited tree-shaking, A production build also runs limited dead code elimination.",


Minor edit period instead of comma: When true, sets the build configuration to the production target.\nAll builds make use of bundling and limited tree-shaking. A production build also runs limited dead code elimination."

jenniferfell · 2018-11-02T18:30:17Z

packages/angular/cli/commands/run-long.md

@@ -0,0 +1,16 @@
+Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.
+The CLI commands run Architect targets such as `build`, `serve`, `test` and `lint`.


Minor edit: test, and lint.

jenniferfell · 2018-11-02T18:31:20Z

packages/angular/cli/commands/run.json

@@ -1,8 +1,8 @@
 {
  "$schema": "http://json-schema.org/schema",
  "$id": "ng-cli://commands/run.json",
-  "description": "Runs a custom target defined in your project.",
-  "$longDescription": "",
+  "description": "Runs an architect target with an optional custom builder configuration defined in your project.",


Edit: Architect in caps everywhere? (I don't have a pref. This is the only lowercase i noticed so far)

jenniferfell · 2018-11-02T18:51:29Z

packages/schematics/angular/ng-new/schema.json

      "type": "boolean",
      "default": true
    },
    "minimal": {
-      "description": "Create a barebones project without any testing frameworks",
+      "description": "When true, creates a barebones project without any testing frameworks.",


Same comment...maybe remove "barebones"

jenniferfell · 2018-11-02T18:52:07Z

packages/schematics/angular/service/schema.json

@@ -29,17 +30,17 @@
    "flat": {
      "type": "boolean",
      "default": true,
-      "description": "Flag to indicate if a directory is created."
+      "description": "When true (the default) creates files at the top level of the project."


When true (the default), creates

jenniferfell · 2018-11-02T18:53:13Z

packages/schematics/angular/workspace/schema.json

@@ -14,7 +14,7 @@
      }
    },
    "experimentalAngularNext": {
-      "description": "Use the next version of Angular (@next dist-tag).",
+      "description": "True to use the next version of Angular (@next dist-tag).",


Maybe: When true, uses the next version...

jenniferfell · 2018-11-02T18:53:29Z

packages/schematics/angular/workspace/schema.json

      "type": "boolean",
      "default": false
    },
    "linkCli": {
-      "description": "Link CLI to global version (internal development only).",
+      "description": "When true, link CLI to global version (internal development only).",


Same ? as above

jenniferfell · 2018-11-02T18:54:00Z

packages/schematics/angular/workspace/schema.json

@@ -75,7 +75,7 @@
      }
    },
    "minimal": {
-      "description": "Create a barebones project without any testing frameworks",
+      "description": "When true, creates a bare-bones project without any testing frameworks",


Remove "bare-bones"?

ngbot · 2018-11-07T06:47:41Z

Hi @jbogarthyde! This PR has merge conflicts due to recent upstream merges.
Please help to unblock it by resolving these conflicts. Thanks!

jbogarthyde · 2018-11-08T22:19:24Z

@jenniferfell @hansl All comments have been addressed. I think this can be merged, I don't know why it is blocked.

filipesilva · 2018-11-09T18:03:03Z

@hansl @alan-agius4 the docs-preview branch is behind master right now and in conflict. It is also a protect branch though, so it cannot be rebased. I'm not sure what the plan is for this branch.

Is it supposed to receive cherry picks from master? Either way for this PR to go in docs-preview needs to be updated to master.

angular-automatic-lock-bot · 2019-09-12T17:41:34Z

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.}

jbogarthyde added 9 commits October 25, 2018 08:35

docs: edit and expand command docs

fa00d50

docs: edit run terminology

d039c8a

docs: edit run description

239a217

docs: edit build description

d779ff0

docs: add generation schematics option docs

3c39525

docs: remove uglify reference

beed643

docs: fix run syntax

c6d296a

docs: change folder to dir

5d11853

Merge branch 'docs-preview' of https://github.com/angular/angular-cli …

001609a

…into docs-preview

googlebot added the cla: yes label Nov 1, 2018

jbogarthyde requested review from hansl and alan-agius4 November 1, 2018 16:29

jbogarthyde added area: docs Related to the documentation target: patch This PR is targeted for the next patch release labels Nov 1, 2018

This was referenced Nov 1, 2018

Add and edit docs for generate subcommands #12743

Closed

Edit and expand command docs #12741

Closed

Merge branch 'master' of https://github.com/angular/angular-cli into …

035fadf

…docs-preview

alan-agius4 reviewed Nov 2, 2018

View reviewed changes

alan-agius4 mentioned this pull request Nov 2, 2018

ci: add skip to appveyor #12851

Merged

jenniferfell approved these changes Nov 2, 2018

View reviewed changes

alan-agius4 mentioned this pull request Nov 8, 2018

The difference between ng build --prod and ng build --configuration=production is unclear. #12898

Closed

vikerman added the state: blocked label Nov 8, 2018

hansl closed this in 9da4bdc Nov 13, 2018

hansl deleted the docs-preview branch November 13, 2018 21:18

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 12, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs preview #12837

Docs preview #12837

jbogarthyde commented Nov 1, 2018 •

edited by alan-agius4

Loading

alan-agius4 Nov 2, 2018

jbogarthyde Nov 2, 2018 •

edited

Loading

alan-agius4 Nov 2, 2018 •

edited

Loading

jenniferfell left a comment

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

jenniferfell Nov 2, 2018

ngbot bot commented Nov 7, 2018

jbogarthyde commented Nov 8, 2018

filipesilva commented Nov 9, 2018

angular-automatic-lock-bot bot commented Sep 12, 2019

		@@ -1,3 +1,14 @@
		Uses the Webpack build tool, with default configuration options specified in the workspace configuration file, `angular.json`, or with a named alternative configuration.

		@@ -0,0 +1,16 @@
		Architect is the tool that the CLI uses to perform complex tasks such as compilation, according to provided configurations.
		The CLI commands run Architect targets such as `build`, `serve`, `test` and `lint`.

Docs preview #12837

Docs preview #12837

Conversation

jbogarthyde commented Nov 1, 2018 • edited by alan-agius4 Loading

Choose a reason for hiding this comment

jbogarthyde Nov 2, 2018 • edited Loading

Choose a reason for hiding this comment

alan-agius4 Nov 2, 2018 • edited Loading

Choose a reason for hiding this comment

jenniferfell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ngbot bot commented Nov 7, 2018

jbogarthyde commented Nov 8, 2018

filipesilva commented Nov 9, 2018

angular-automatic-lock-bot bot commented Sep 12, 2019

jbogarthyde commented Nov 1, 2018 •

edited by alan-agius4

Loading

jbogarthyde Nov 2, 2018 •

edited

Loading

alan-agius4 Nov 2, 2018 •

edited

Loading