Skip to content
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

Angular AIO General Setup - Missing instructions needed in the root #25759

Closed
FrederikSchlemmer opened this issue Aug 31, 2018 · 5 comments
Closed

Comments

@FrederikSchlemmer
Copy link
Contributor

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead see https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question
[x] Other... Please describe:
The executed "yarn setup" command cannot be completed and terminates with an error during the creation of the documentation.

Current behavior

The current behavior is that after the conversion of the necessary symlinks (chapter: Developing under Windows) and the execution of 'yarn' the following command 'yarn setup' fails.
Furthermore, the 'yarn docs' command also fails with the same error.
From this I conclude that the problem arises during the generation of the documentation, perhaps?

image

Expected behavior

The steps given for the 'General Setup' under 'Guide to authoring' should be straightforward.

Minimal reproduction of the problem with instructions

To reproduce the error, the following steps must be carried out:

  • Copying the current master branch
  • Creating the suitable Windows symlinks
  • Work through the 'General Setup' under 'Guide to authoring'

What is the motivation / use case for changing the behavior?

Ability to test contributions before a pull request is submitted.

Environment


Angular version: Latest Repo version


Browser:
- [ ] Chrome (desktop) version XX
- [ ] Chrome (Android) version XX
- [ ] Chrome (iOS) version XX
- [ ] Firefox version XX
- [ ] Safari (desktop) version XX
- [ ] Safari (iOS) version XX
- [ ] IE version XX
- [ ] Edge version XX
 
For Tooling issues:
- Node version: v8.11.2  
- Yarn version: v1.7.0
- Platform: Windows 10  

Others:

@brandonroberts
Copy link
Contributor

Run yarn in the root of the project first before going into the aio folder and running yarn, yarn setup, etc..

@FrederikSchlemmer
Copy link
Contributor Author

@brandonroberts I think this part should be better documented. The step with the "yarn" in the root folder is not mentioned anywhere.

Or should the sentence "ensure the dependencies are installed" reference it?

@FrederikSchlemmer FrederikSchlemmer changed the title Angular AIO General Setup for Authoring - "yarn setup" fails Angular AIO General Setup - Missing instructions needed in the root Sep 4, 2018
@brandonroberts
Copy link
Contributor

I agree as it wasn't previously required to install dependencies at the root also. I think @petebacondarwin is fixing this so you don't have to explicitly do that.

@ngbot ngbot bot added this to the needsTriage milestone Sep 4, 2018
@petebacondarwin
Copy link
Member

I'll add a yarn install at the root level into the yarn setup in the aio folder.

petebacondarwin added a commit to petebacondarwin/angular that referenced this issue Sep 5, 2018
Now that the doc-gen parses the imports of TS source
files we need to ensure that the root node_modules
exists. Otherwise running `yarn docs` produces an
obscure error:

```
Error: No SourceFile found with path node_modules/@types/jasmine/index.d.ts
```

Closes angular#25759
@petebacondarwin petebacondarwin modified the milestones: needsTriage, Backlog Sep 5, 2018
@ngbot ngbot bot modified the milestones: Backlog, needsTriage Sep 5, 2018
@petebacondarwin petebacondarwin added this to MERGE in docs-infra Sep 5, 2018
mhevery pushed a commit that referenced this issue Sep 5, 2018
Now that the doc-gen parses the imports of TS source
files we need to ensure that the root node_modules
exists. Otherwise running `yarn docs` produces an
obscure error:

```
Error: No SourceFile found with path node_modules/@types/jasmine/index.d.ts
```

Closes #25759

PR Close #25811
@mhevery mhevery closed this as completed in c1ae3c1 Sep 5, 2018
FrederikSchlemmer pushed a commit to FrederikSchlemmer/angular that referenced this issue Jan 3, 2019
Now that the doc-gen parses the imports of TS source
files we need to ensure that the root node_modules
exists. Otherwise running `yarn docs` produces an
obscure error:

```
Error: No SourceFile found with path node_modules/@types/jasmine/index.d.ts
```

Closes angular#25759

PR Close angular#25811
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Development

Successfully merging a pull request may close this issue.

4 participants