Skip to content
Please note that GitHub no longer supports Internet Explorer.

We recommend upgrading to the latest Microsoft Edge, Google Chrome, or Firefox.

Learn more

/angular

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 developer guide for use with yarn #29044

Closed
wants to merge 1 commit into
base: master
from
+9 −42

Conversation

Reviewers

@gkalpak gkalpak

@IgorMinar IgorMinar

Assignees
No one assigned
Labels
PR action: merge PR target: master & patch cla: yes comp: docs
Projects
None yet
Milestone
  needsTriage
6 participants
@Splaktar @gkalpak @googlebot @brandonroberts @kara @matsko
@Splaktar
Copy link
Member

Splaktar commented Feb 28, 2019

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

The Developer Guide provides commands that require gulp to be globally installed.
There is also a confusing section around using $(yarn bin) which doesn't work as described (missing / on macOS), it actually should have shown an example like $(yarn bin)/gulp lint. It's better to use another approach that doesn't have a possibly platform-specific file separator character.

Issue Number: N/A

What is the new behavior?

  • remove reference to npm
  • remove confusing optional comments and $(yarn bin) with missing /
  • remove reference to protractor commands which don't exist
  • provide yarn commands which don't require gulp installed globally

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@Splaktar Splaktar requested a review from IgorMinar as a code owner Feb 28, 2019

@googlebot googlebot added the cla: yes label Feb 28, 2019

@gkalpak

gkalpak approved these changes Mar 1, 2019
View changes

Copy link
Member

gkalpak left a comment

👍 for cleaning this up 💯

Other possible improvements/fixes you might want to make:

  • The script for publising build artifacts has been moved:
    ./scripts/publish/publish-build-artifacts.sh --> ./scripts/ci/publish-build-artifacts.sh
  • The Formatting your source code > VS Code section is obsolete. (The .vscode/settings.json file is now part of the repo.)
  • The Bazel support > VS Code section is outdated. The changes to settings.json don't seem to be necessary any more (so 2. could go away altogether). You could also add devondcarew.bazel-code to the list of recommended extensions.
  • The General IDE settings > VS Code section is outdated (and probably obsolete). The .vscode/settings.json file is now part of the repo, so people can't just go there and add stuff. We could add these settings to settings.json and check them in, but the ones already in settings.json look better to me, so I would just remove that section from the Developer guide.
Show resolved Hide resolved docs/DEVELOPER.md Outdated

@gkalpak gkalpak added PR action: cleanup comp: docs PR target: master & patch labels Mar 1, 2019

@ngbot ngbot bot added this to the needsTriage milestone Mar 1, 2019

@Splaktar Splaktar force-pushed the DevIntent:docs-developer-guide-yarn-updates branch from 4f8e1ef to 5b81185 Mar 1, 2019

@Splaktar

This comment has been minimized.

Sign in to view
Copy link
Member Author

Splaktar commented Mar 1, 2019

@gkalpak thank you for the helpful review! Updates pushed.
@gkalpak

gkalpak reviewed Mar 2, 2019
View changes

Show resolved Hide resolved docs/DEVELOPER.md Outdated
Show resolved Hide resolved .vscode/extensions.json Outdated

@Splaktar Splaktar referenced this pull request Mar 7, 2019

Open

docs: update developer guide for testing and IntelliJ #29048

4 of 14 tasks complete
@Splaktar

This comment has been minimized.

Sign in to view
Copy link
Member Author

Splaktar commented Mar 7, 2019

@gkalpak in https://github.com/angular/angular/pull/29048/files#r262150563, @brandonroberts suggested that we recommend https://marketplace.visualstudio.com/items?itemName=BazelBuild.vscode-bazel instead. Thoughts?
@Splaktar
docs: update developer guide for use with yarn 
remove reference to npm
remove confusing optional comments and $(yarn bin) with missing /
remove reference to protractor commands which don't exist
provide yarn commands which don't require gulp installed globally
Verified
This commit was signed with a verified signature.
@Splaktar Splaktar Michael Prentice
GPG key ID: A21110C72E90BFB7 Learn about signing commits
Loading status checks…
e184a07

@Splaktar Splaktar force-pushed the DevIntent:docs-developer-guide-yarn-updates branch from 5b81185 to e184a07 Mar 7, 2019

@gkalpak

This comment has been minimized.

Sign in to view
Copy link
Member

gkalpak commented Mar 7, 2019

I haven't tried BazelBuild.vscode-bazel. It seems to do more than the average user would do (and might be a little overwhelming for people not familiar with bazel). But it might be a better alternative (being the official extension, etc.).

I don't feel strongly about either. Up to you 😁

(BTW, if we decide to use it, we should add the necessary settings in .vscode/settings.json.)
@Splaktar

This comment has been minimized.

Sign in to view
Copy link
Member Author

Splaktar commented Mar 7, 2019

OK, I don't feel strongly about it either and I am not a VSCode user. So I will leave that to a separate PR. Thank you for your feedback!

@brandonroberts brandonroberts added PR action: merge and removed PR action: cleanup labels Mar 12, 2019

@kara kara added the PR action: review label Mar 12, 2019

@matsko matsko removed the PR action: review label Mar 14, 2019

matsko added a commit that referenced this pull request Mar 14, 2019

@Splaktar @matsko
docs: update developer guide for use with yarn (#29044) 
remove reference to npm
remove confusing optional comments and $(yarn bin) with missing /
remove reference to protractor commands which don't exist
provide yarn commands which don't require gulp installed globally

PR Close #29044
Loading status checks…
d787925

@matsko matsko closed this in 1a9ab27 Mar 14, 2019

@Splaktar Splaktar deleted the DevIntent:docs-developer-guide-yarn-updates branch Mar 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.