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.
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
docs: update npm packages to be accurate for v7 #26422
Conversation
aio/content/guide/npm-packages.md
Outdated
@@ -155,19 +147,18 @@ Built on top of [WebDriverJS](https://github.com/SeleniumHQ/selenium/wiki/WebDri | |||
the TypeScript language server, including the *tsc* TypeScript compiler. | |||
|
|||
|
|||
## So many packages! So many files! | |||
## Managing packages and files | |||
|
|||
The default `package.json` installs more packages than you'll need for your project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is an odd statement. The CLI scaffolds the project with the minimum amount of packages needed.
aio/content/guide/npm-packages.md
Outdated
@@ -155,19 +147,18 @@ Built on top of [WebDriverJS](https://github.com/SeleniumHQ/selenium/wiki/WebDri | |||
the TypeScript language server, including the *tsc* TypeScript compiler. | |||
|
|||
|
|||
## So many packages! So many files! | |||
## Managing packages and files | |||
|
|||
The default `package.json` installs more packages than you'll need for your project. | |||
|
|||
A given package may contain tens, hundreds, even thousands of files, | |||
all of them in your local machine's `node_modules` directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this sounds scary. remove
58c9a04
to
5b38230
Compare
You can preview 5b38230 at https://pr26422-5b38230.ngbuilds.io/. |
You can preview 697ceab at https://pr26422-697ceab.ngbuilds.io/. |
697ceab
to
bdbe716
Compare
You can preview bdbe716 at https://pr26422-bdbe716.ngbuilds.io/. |
there are still many unresolved comments on this pr |
bdbe716
to
4e3b615
Compare
You can preview 4e3b615 at https://pr26422-4e3b615.ngbuilds.io/. |
4e3b615
to
2de0e55
Compare
You can preview 2de0e55 at https://pr26422-2de0e55.ngbuilds.io/. |
You can preview b668c2d at https://pr26422-b668c2d.ngbuilds.io/. |
@IgorMinar : Ready for another look.
Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A1: workspace scoped
A2: neither is great. packages are dependencies. so we just repeat the same thing using two different words. how about: “npm dependencies” and “Workspace npm dependencies”?
A3: left in inline comment. the rest looks good.
I'm going to approve this because it's almost done. Let's change the title, resolve the other issues and get this in. |
5791c46
to
d1eb8bd
Compare
You can preview d1eb8bd at https://pr26422-d1eb8bd.ngbuilds.io/. |
@Splaktar Thanks for this tip. I don't think it's covered in the AIO docs, and I don't see it clearly stated on the CLI wiki. In general, we're trying to do a better job of including information about library development (we have a few top-of-backlog items), so I included a brief mention and link to |
You can preview 296f04f at https://pr26422-296f04f.ngbuilds.io/. |
You can preview a368f7c at https://pr26422-a368f7c.ngbuilds.io/. |
@IgorMinar Here, again. I changed navigation.json so now the PR needs a fresh approval from someone in the marketing group. Thx. |
Other than that approval, I think it's ready. I've incorporated all review feedback, updated and added cross-reference links, and moved the lists into tables that are easier to read. (When I added links, scanning the in-line titles became harder. The table fixes that.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
a368f7c
to
d9415fb
Compare
You can preview d9415fb at https://pr26422-d9415fb.ngbuilds.io/. |
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Npm packages doc was not current for v7.
Issue Number: N/A
What is the new behavior?
The doc needs a larger rewrite, but this PR is to make it accurate in the ways mentioned above.
Also made some copy edits.
Does this PR introduce a breaking change?
Other information