Skip to content

Commit 5f9ead1

Browse files
committed
incorporate Ward's feedback
1 parent 647a8fc commit 5f9ead1

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

docs/documentation/stories/moving-into-the-cli.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ as an example, but you should be able to adjust these instructions to other setu
1010
Note for Windows users: we show unix commands here like `cp -r` to copy and `rm -rf` to delete files.
1111
Windows does not have these commands so use Explorer instead.
1212

13-
Start with preparing your existing project folder, let's call it `awesome-app`.
13+
Start with preparing your existing project folder. We'll refer to it as `awesome-app`.
1414
- commit and push your existing changes.
1515
- clean your folder from temporary files and ignored files using `git clean -fdx`.
1616
- rename your project folder to `old-awesome-app`.
@@ -24,18 +24,18 @@ Now make a new project on the same parent folder as `old-awesome-app` using Angu
2424

2525
Copy over your app files.
2626
- Remove the existing app: `rm -rf src/app src/styles.css src/index.html e2e`.
27-
- Copy `src/app/`, `src/index.html`, `src/styles.css` and `e2e/`.
27+
- Copy `src/app/`, `src/index.html`, `src/styles.css` and `e2e/` from your old app.
2828
If you don't have a `src/` folder then these files and folders should be
2929
at the root of the old project instead.
3030
```
31-
cp -r ../old-awesome-project/src/app ./src/app
32-
cp ../old-awesome-project/src/index.html ./src/index.html
33-
cp ../old-awesome-project/src/styles.css ./src/styles.css
34-
cp -r ../old-awesome-project/e2e ./e2e/
31+
cp -r ../old-awesome-app/src/app ./src/app
32+
cp ../old-awesome-app/src/index.html ./src/index.html
33+
cp ../old-awesome-app/src/styles.css ./src/styles.css
34+
cp -r ../old-awesome-app/e2e ./e2e/
3535
```
36-
- Don't copy `../old-awesome-project/src/main.ts`. Instead compare it to the new `./src/main.ts`
36+
- Don't copy `../old-awesome-app/src/main.ts`. Instead compare it to the new `./src/main.ts`
3737
and manually copy any extra code the old one has.
38-
- Compare `../old-awesome-project/package.json` to the new `./package.json` and add in your
38+
- Compare `../old-awesome-app/package.json` to the new `./package.json` and add in your
3939
third party libraries and `@types/*` packages, project descriptions and any other fields.
4040
- Run `npm install` to install any packages you added.
4141
- Copy over any other files your app needs like images into `src/assets`.
@@ -53,10 +53,10 @@ relative paths instead.
5353
- Do the same for any remaining script tags as well, using the `scripts` array instead.
5454

5555
The final step is to copy your git history so you can continue working without losing anything:
56-
- Copy over the git folder: `cp -r ../old-awesome-project/.git .git`
56+
- Copy over the git folder: `cp -r ../old-awesome-app/.git .git`
5757
- Commit and push your changes as normal.
5858

59-
You can now delete `../old-existing-project`, and you're done!
59+
You can now delete `../old-awesome-app`, and you're done!
6060

6161
The CLI runs static analysis on your code to ensure it's AOT ready, so you might run into a few
6262
new compilation errors that weren't there before.

docs/documentation/stories/moving-out-of-the-cli.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,22 @@ Moving out of the CLI is very similar to [Moving into the CLI](moving-into-the-c
1111
You'll have to make a brand new project using your new project seed, move your app files and
1212
cater to any changes in the build process.
1313

14-
Start with preparing your existing project folder, let's call it `awesome-app`.
14+
Start with preparing your existing project folder. We'll refer to it as `awesome-app`.
1515
- commit and push your existing changes.
1616
- clean your folder from temporary files and ignored files using `git clean -fdx`.
1717
- rename your project folder to `old-awesome-app`.
1818

19-
Now make a new project on the same folder as `old-awesome-app`.
19+
Now make a new project on the same parent folder as `old-awesome-app`.
2020
- Make a new app using your new project seed in a new `awesome-app` folder.
2121
- Move into the folder: `cd awesome-app`.
2222

2323
Copy over your app files.
2424
- Locate `app/`, `styles.css` and the end-to-end test folder in your new project.
2525
- Replace them with the corresponding files from `../old-awesome-app`.
26-
- Don't copy `../old-awesome-project/src/main.ts`. It contains custom logic for the CLI
26+
- Don't copy `../old-awesome-app/src/main.ts`. It contains custom logic for the CLI
2727
`environments` feature. Instead compare code and take only what you need.
2828
- Do the same for `index.html`.
29-
- Compare `../old-awesome-project/package.json` to the new `./package.json` and add in your
29+
- Compare `../old-awesome-app/package.json` to the new `./package.json` and add in your
3030
third party libraries and `@types/*` packages, project descriptions and any other fields.
3131
- Run `npm install` to install any packages you added.
3232
- Copy over any other files your app needs like images, icons, etc.
@@ -40,10 +40,10 @@ project.
4040
and `styles` array. Check import these in your new project and add them accordingly.
4141

4242
The final step is to copy your git history so you can continue working without losing anything:
43-
- Copy over the git folder: `cp -r ../old-awesome-project/.git .git`
43+
- Copy over the git folder: `cp -r ../old-awesome-app/.git .git`
4444
- Commit and push your changes as normal.
4545

46-
You can now delete `../old-existing-project`, and you're done!
46+
You can now delete `../old-awesome-app`, and you're done!
4747

4848
Every project seed does things slightly different so if you are running into problems be sure
4949
to ask in their issue tracker.

0 commit comments

Comments
 (0)