Skip to content

docs: edit ng serve option doc #13210

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

Merged
merged 3 commits into from
Dec 26, 2018
Merged

docs: edit ng serve option doc #13210

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69961cb
docs: edit ng serve option doc
jbogarthyde Dec 17, 2018
b5ae482
docs: clarify public-host option
jbogarthyde Dec 20, 2018
10cdee3
docs: dev server
jbogarthyde Dec 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions packages/angular/cli/lib/config/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1063,62 +1063,62 @@
},
"open": {
"type": "boolean",
"description": "Opens the url in default browser.",
"description": "When true, open the live-reload URL in default browser.",
"default": false,
"alias": "o"
},
"liveReload": {
"type": "boolean",
"description": "Whether to reload the page on change, using live-reload.",
"description": "When true, reload the page on change using live-reload.",
"default": true
},
"publicHost": {
"type": "string",
"description": "Specify the URL that the browser client will use."
"description": "The URL that the browser client will use for live reload."
Copy link
Contributor

Choose a reason for hiding this comment

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

publicHost is not just about live-reload. @clydin can you offer a better description please?

Copy link
Member

Choose a reason for hiding this comment

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

for live reload -> to connect to the development server

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The issue was that the user didn't relate publicHost to live-reload. How about this:
"The URL that the browser client will use to connect to the development server for live-reload."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@clydin Please check new text

},
"servePath": {
"type": "string",
"description": "The pathname where the app will be served."
},
"disableHostCheck": {
"type": "boolean",
"description": "Don't verify connected clients are part of allowed hosts.",
"description": "When true, don't verify that connected clients are part of allowed hosts.",
"default": false
},
"hmr": {
"type": "boolean",
"description": "Enable hot module replacement.",
"description": "When true, enable hot module replacement.",
"default": false
},
"watch": {
"type": "boolean",
"description": "Rebuild on change.",
"description": "When true, rebuild on change.",
"default": true
},
"hmrWarning": {
"type": "boolean",
"description": "Show a warning when the --hmr option is enabled.",
"description": "When true, show a warning when the --hmr option is enabled.",
"default": true
},
"servePathDefaultWarning": {
"type": "boolean",
"description": "Show a warning when deploy-url/base-href use unsupported serve path values.",
"description": "When true, show a warning when deploy-url/base-href use unsupported serve path values.",
"default": true
},
"optimization": {
"description": "Enables optimization of the build output.",
"description": "Enable optimization of the build output.",
"oneOf": [
{
"type": "object",
"properties": {
"scripts": {
"type": "boolean",
"description": "Enables optimization of the scripts output.",
"description": "When true, enable optimization of the scripts output.",
"default": true
},
"styles": {
"type": "boolean",
"description": "Enables optimization of the styles output.",
"description": "When true, enable optimization of the styles output.",
"default": true
}
},
Expand All @@ -1131,28 +1131,28 @@
},
"aot": {
"type": "boolean",
"description": "Build using Ahead of Time compilation."
"description": "Build using ahead-of-time compilation."
},
"sourceMap": {
"description": "Output sourcemaps.",
"description": "When true, output sourcemaps.",
"default": true,
"oneOf": [
{
"type": "object",
"properties": {
"scripts": {
"type": "boolean",
"description": "Output sourcemaps for all scripts.",
"description": "When true, output sourcemaps for all scripts.",
"default": true
},
"styles": {
"type": "boolean",
"description": "Output sourcemaps for all styles.",
"description": "When true, output sourcemaps for all styles.",
"default": true
},
"vendor": {
"type": "boolean",
"description": "Resolve vendor packages sourcemaps.",
"description": "When true, resolve vendor packages sourcemaps.",
"default": false
}
},
Expand All @@ -1165,20 +1165,20 @@
},
"vendorSourceMap": {
"type": "boolean",
"description": "Resolve vendor packages sourcemaps.",
"description": "When true, resolve vendor packages sourcemaps.",
"default": false
},
"evalSourceMap": {
"type": "boolean",
"description": "Output in-file eval sourcemaps."
"description": "When true, output in-file eval sourcemaps."
},
"vendorChunk": {
"type": "boolean",
"description": "Use a separate bundle containing only vendor libraries."
"description": "When true, use a separate bundle containing only vendor libraries."
},
"commonChunk": {
"type": "boolean",
"description": "Use a separate bundle containing code used across multiple bundles."
"description": "When true, use a separate bundle containing code used across multiple bundles."
},
"baseHref": {
"type": "string",
Expand All @@ -1190,11 +1190,11 @@
},
"verbose": {
"type": "boolean",
"description": "Adds more details to output logging."
"description": "When true, add more details to output logging."
},
"progress": {
"type": "boolean",
"description": "Log progress to the console while building."
"description": "When true, log progress to the console while building."
}
},
"additionalProperties": false
Expand Down