diff --git a/docs/design/docker-deploy.md b/docs/design/docker-deploy.md index bd0ec6740b68..634fdc8b3e21 100644 --- a/docs/design/docker-deploy.md +++ b/docs/design/docker-deploy.md @@ -97,7 +97,7 @@ If an `env` name is provided, other than "default", generate compose files with If `--use-image == false` and the selected machine for the environment is a Docker Swarm machine, warn the user. Docker Swarm clusters cannot use the `build:` option in compose, since the resulting built image will not be distributed to other nodes. Swarm requires using the `image:` option in compose, pushing the image to a registry beforehand so that the Swarm nodes have a place to pull the image from (see [Swarm Limitations](https://docs.docker.com/compose/swarm/#building-images)). -Certain configuration values will be stored in the project's ngConfig `angular-cli.json` for use with other docker commands (ie. deploy, logs, exec). See also: [Saved State](#saved-state) section. +Certain configuration values will be stored in the project's ngConfig `.angular-cli.json` for use with other docker commands (ie. deploy, logs, exec). See also: [Saved State](#saved-state) section. Provide instructions on what the user can do after initialization completes (push, deploy). diff --git a/docs/design/ngConfig.md b/docs/design/ngConfig.md index bb3573212900..e37f1cf0e689 100644 --- a/docs/design/ngConfig.md +++ b/docs/design/ngConfig.md @@ -16,14 +16,14 @@ Since the data is static, we only need to keep it in a static store somewhere. One solution would be to keep the data in the `package.json`. Unfortunately, the metadata contains too much data and the `package.json` file would become unmanageable. -Instead of polluting the package file, a `angular-cli.json` file will be created that contains all the values. Access to that file will be allowed to the user if he knows the structure of the file (unknown keys will be kept but ignored), and it's easy to read and write. +Instead of polluting the package file, a `.angular-cli.json` file will be created that contains all the values. Access to that file will be allowed to the user if he knows the structure of the file (unknown keys will be kept but ignored), and it's easy to read and write. ## Fallback -There should be two `angular-cli.json` files; one for the project and a general one. The general one should contain information that can be useful when scaffolding new apps, or informations about the user. +There should be two `.angular-cli.json` files; one for the project and a general one. The general one should contain information that can be useful when scaffolding new apps, or informations about the user. -The project `angular-cli.json` goes into the project root. The global configuration should live at `$HOME/.angular-cli.json`. +The project `.angular-cli.json` goes into the project root. The global configuration should live at `$HOME/.angular-cli.json`. ## Structure diff --git a/docs/documentation/build.md b/docs/documentation/build.md index 4ffb5953042d..8724ff59f1f1 100644 --- a/docs/documentation/build.md +++ b/docs/documentation/build.md @@ -19,7 +19,7 @@ The build artifacts will be stored in the `dist/` directory. environment file to be used with that build (`--environment=dev` or `--environment=prod`). By default, the development build target and environment are used. -The mapping used to determine which environment file is used can be found in `angular-cli.json`: +The mapping used to determine which environment file is used can be found in `.angular-cli.json`: ```json "environments": { @@ -46,7 +46,7 @@ ng build You can also add your own env files other than `dev` and `prod` by doing the following: - create a `src/environments/environment.NAME.ts` -- add `{ "NAME": 'src/environments/environment.NAME.ts' }` to the `apps[0].environments` object in `angular-cli.json` +- add `{ "NAME": 'src/environments/environment.NAME.ts' }` to the `apps[0].environments` object in `.angular-cli.json` - use them via the `--env=NAME` flag on the build/serve commands. ### Base tag handling in index.html diff --git a/docs/documentation/e2e.md b/docs/documentation/e2e.md index dd226eef9ae7..48a0446f6663 100644 --- a/docs/documentation/e2e.md +++ b/docs/documentation/e2e.md @@ -14,7 +14,7 @@ ng e2e 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`. +`--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`). diff --git a/docs/documentation/stories/asset-configuration.md b/docs/documentation/stories/asset-configuration.md index 9809f28f0667..0f1a2a170053 100644 --- a/docs/documentation/stories/asset-configuration.md +++ b/docs/documentation/stories/asset-configuration.md @@ -1,6 +1,6 @@ # Project assets -You use the `assets` array in `angular-cli.json` to list files or folders you want to copy as-is +You use the `assets` array in `.angular-cli.json` to list files or folders you want to copy as-is when building your project. By default, the `src/assets/` folder and `src/favicon.ico` are copied over. diff --git a/docs/documentation/stories/global-lib.md b/docs/documentation/stories/global-lib.md index 756dbc952d04..3583b5f143d2 100644 --- a/docs/documentation/stories/global-lib.md +++ b/docs/documentation/stories/global-lib.md @@ -2,7 +2,7 @@ Some javascript libraries need to be added to the global scope, and loaded as if they were in a script tag. We can do this using the `apps[0].scripts` and -`apps[0].styles` properties of `angular-cli.json`. +`apps[0].styles` properties of `.angular-cli.json`. As an example, to use [Bootstrap 4](http://v4-alpha.getbootstrap.com/) this is what you need to do: diff --git a/docs/documentation/stories/global-scripts.md b/docs/documentation/stories/global-scripts.md index 0d8a2be58f60..cc1021d25fe7 100644 --- a/docs/documentation/stories/global-scripts.md +++ b/docs/documentation/stories/global-scripts.md @@ -1,7 +1,7 @@ # Global styles You can add Javascript files to the global scope via the `apps[0].scripts` -property in `angular-cli.json`. +property in `.angular-cli.json`. These will be loaded exactly as if you had added them in a `