From e0b4efb6cb7ba1aa33231a01cc196d1b3b378fbc Mon Sep 17 00:00:00 2001 From: Ward Bell Date: Thu, 5 Jan 2017 18:52:07 -0800 Subject: [PATCH] docs(setup): instructs to delete non-essential files --- .../setup/ts/non-essential-files.txt | 13 ++++++++ .../latest/guide/setup-systemjs-anatomy.jade | 9 ++++++ public/docs/ts/latest/guide/setup.jade | 31 ++++++++++++++++++- 3 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 public/docs/_examples/setup/ts/non-essential-files.txt diff --git a/public/docs/_examples/setup/ts/non-essential-files.txt b/public/docs/_examples/setup/ts/non-essential-files.txt new file mode 100644 index 0000000000..3c9cdde9dc --- /dev/null +++ b/public/docs/_examples/setup/ts/non-essential-files.txt @@ -0,0 +1,13 @@ +.git +.gitignore +.travis.yml +*.spec*.ts +CHANGELOG.md +e2e +favicon.ico +karma.conf.js +karma-test-shim.js +LICENSE +non-essential-files.txt +protractor.config.js +README.md diff --git a/public/docs/ts/latest/guide/setup-systemjs-anatomy.jade b/public/docs/ts/latest/guide/setup-systemjs-anatomy.jade index 2f6f79fe23..a5ddb79fd6 100644 --- a/public/docs/ts/latest/guide/setup-systemjs-anatomy.jade +++ b/public/docs/ts/latest/guide/setup-systemjs-anatomy.jade @@ -90,6 +90,15 @@ table(width="100%") :marked Script to run karma with SystemJS as described in the [Testing](testing.html) guide. + tr + td non-essential-files.txt + td + :marked + A list of files that you can delete if you want to purge your setup of the + original QuickStart Seed testing and git maintainence artifacts. + See instructions in the optional + [_Deleting non-essential files_](setup.html#non-essential "Setup: Deleting non-essential files") section. + *Do this only in the beginning to avoid accidentally deleting your own tests and git setup!* tr td LICENSE td diff --git a/public/docs/ts/latest/guide/setup.jade b/public/docs/ts/latest/guide/setup.jade index 8db101b32a..e87e75d979 100644 --- a/public/docs/ts/latest/guide/setup.jade +++ b/public/docs/ts/latest/guide/setup.jade @@ -64,7 +64,36 @@ code-example(language="sh" class="code-shell"). :marked `npm start` fails in _Bash for Windows_ which does not support networking to servers as of January, 2017. -.l-main-section#seed +a#non-essential +.l-main-section +:marked + ## Delete _non-essential_ files (optional) + + You can quickly delete the _non-essential_ files that concern testing and QuickStart repository maintenance + (***including all git-related artifacts*** such as the `.git` folder and `.gitignore`!). + +.alert.is-important + :marked + Do this only in the beginning to avoid accidentally deleting your own tests and git setup! + +:marked + Open a terminal window in the project folder and enter the following commands for your environment: + + ### OS/X (bash) +code-example(language="sh" class="code-shell"). + xargs -a non-essential-files.txt rm -rf + rm app/*.spec*.ts + rm non-essential-files.txt + +:marked + ### Windows +code-example(language="sh" class="code-shell"). + for /f %i in (non-essential-files.txt) do del %i /F /S /Q + rd .git /s /q + rd e2e /s /q + +a#seed +.l-main-section :marked ## What's in the QuickStart seed?