build(aio): big move of docs related files #14361

petebacondarwin · 2017-02-08T18:11:39Z

All the docs related files (docs-app, doc-gen, content, etc)
are now to be found inside the /aio folder.

The related gulp tasks have been moved from the top level
gulp file to a new one inside the /aio folder.

The structure of the /aio folder now looks like:

/aio/
  content/       #MARKDOWN FILES for devguides, cheatsheet, etc
    devguides/
    cheatsheets/
  transforms/    #dgeni packages, templates, etc
  webapp/           # the Angular app
    src/
      app/
      assets/
      content/  #HTML + JSON build artifacts produced by dgeni from /aio/content.
                #This dir is .gitignored-ed

petebacondarwin · 2017-02-08T18:18:56Z

TODO: remove node dependencies from angular/angular that are no longer required

petebacondarwin · 2017-02-08T18:25:12Z

TODO: I feel bad that there is a load of docs related build and test stuff spread throughout the ci-lite folder. I think it would be better if we could move all this to the /aio/gulpfile.js.

wardbell · 2017-02-08T18:55:53Z

I was thinking that aio should have its own gulpfile.js. Undoubtedly there will need to be some way to kick off an aio gulp task or two at the top level. But it would be nice to treat aio as its own world, as if it were its own repo.

petebacondarwin · 2017-02-08T19:01:05Z

@wardbell - that is mostly where this PR puts us. But I didn't want to do too much refactoring in such a monster of a commit.

gkalpak · 2017-02-08T18:21:34Z

.gitignore

@@ -3,7 +3,6 @@
 /dist/
 node_modules
 bower_components
-angular.io/dist


Why this change?

because it is covered further down by the /aio/webapp/src/content/docs?

I believe that @petebacondarwin is right

I can't see it. I agree it existed twice before, but you seem to have removed both occurences.

sorry I just realised (I think) that the ng build process will compile to the dist folder; and that is where you are deploying to firebase from... I'll put that gitignore back in.

In the meantime it also means that I am not sure that ng build will be copying the generated docs to that folder....

gkalpak · 2017-02-08T18:24:56Z

scripts/ci-lite/test_aio.sh

 # Lint the code
-cd "`dirname $0`/../../angular.io"
+cd "`dirname $0`/../../aio"


Shouldn't this go to /aio/webapp (here and elsewhere)?

I don't think so because the yarn is running off the package.json, which I moved to the /aio folder

But I think I need to change the package.json...

Currently, there are files (e.g. aio/webapp/src/tsconfig.json, aio/webapp/e2e/tsconfig.json, aio/webapp/src/angular-cli.json) which assume (afaict) that the project root (i.e. the node_modules/ directory, package.json etc) will be aio/webapp/. If we are moving the project root to aio/, when these files (and probably others) need to be updated accordingly.

I just found out that it is not possible to specify the working directory (cwd) for the firebase command line tool. It must be run from the correct folder :-(
So the options are:

a) move the package.json back inside the webapp folder, next to the firebase.json file; which would mean that the stuff outside that folder does not benefit from the yarn install.
b) move the firebase.json out of the webapp folder; I think this might be the best option
c) change the package.json scripts to cd into that folder before running the firebase tool; I think this is not nice and probably would break on Windows

IgorMinar

LGTM once we resolve the small things I pointed out.

IgorMinar · 2017-02-08T21:49:19Z

aio/gulpfile.js

+// THIS CHECK SHOULD BE THE FIRST THING IN THIS FILE
+// This is to ensure that we catch env issues before we error while requiring other dependencies.
+require('../tools/check-environment')({
+  requiredNpmVersion: '>=3.10.7 <4.0.0',


we don't use npm in aio

IgorMinar · 2017-02-08T21:49:57Z

aio/gulpfile.js

+// This is to ensure that we catch env issues before we error while requiring other dependencies.
+require('../tools/check-environment')({
+  requiredNpmVersion: '>=3.10.7 <4.0.0',
+  requiredNodeVersion: '>=6.9.5 <7.0.0',


I wish we didn't duplicate this in /aio because now we have a yet another place to update the node version in this repo. could we reuse the top level check?

IgorMinar · 2017-02-08T21:50:43Z

aio/jsconfig.json

@@ -0,0 +1,7 @@
+{


what's the purpose of this file? IDE support?

could we document it somehow? e.g. using "comment": "the purpose of this file is... "

googlebot · 2017-02-08T23:55:27Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

All the docs related files (docs-app, doc-gen, content, etc) are now to be found inside the `/aio` folder. The related gulp tasks have been moved from the top level gulp file to a new one inside the `/aio` folder. The structure of the `/aio` folder now looks like: ``` /aio/ build/ # gulp tasks content/ #MARKDOWN FILES for devguides, cheatsheet, etc devguides/ cheatsheets/ transforms/ #dgeni packages, templates, etc src/ app/ assets/ content/ #HTML + JSON build artifacts produced by dgeni from /aio/content. #This dir is .gitignored-ed e2e/ #protractor tests for the doc viewer app node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff #This dir is .gitignored-ed gulpfile.js #Tasks for generating docs and building & deploying the doc viewer ``` Closes angular#14361

googlebot · 2017-02-09T19:32:20Z

CLAs look good, thanks!

All the docs related files (docs-app, doc-gen, content, etc) are now to be found inside the `/aio` folder. The related gulp tasks have been moved from the top level gulp file to a new one inside the `/aio` folder. The structure of the `/aio` folder now looks like: ``` /aio/ build/ # gulp tasks content/ #MARKDOWN FILES for devguides, cheatsheet, etc devguides/ cheatsheets/ transforms/ #dgeni packages, templates, etc src/ app/ assets/ content/ #HTML + JSON build artifacts produced by dgeni from /aio/content. #This dir is .gitignored-ed e2e/ #protractor tests for the doc viewer app node_modules/ #dependencies for both the doc viewer builds and the dgeni stuff #This dir is .gitignored-ed gulpfile.js #Tasks for generating docs and building & deploying the doc viewer ``` Closes angular#14361

angular-automatic-lock-bot · 2019-09-11T01:20:38Z

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.}

petebacondarwin added comp: aio area: build & ci Related the build and CI infrastructure of the project action: review The PR is still awaiting reviews from at least one requested reviewer labels Feb 8, 2017

petebacondarwin assigned IgorMinar Feb 8, 2017

googlebot added the cla: yes label Feb 8, 2017

gkalpak reviewed Feb 8, 2017

View reviewed changes

IgorMinar approved these changes Feb 8, 2017

View reviewed changes

googlebot added cla: no and removed cla: yes labels Feb 8, 2017

petebacondarwin force-pushed the aio-move branch 2 times, most recently from 98a8033 to 791bf39 Compare February 9, 2017 07:48

petebacondarwin force-pushed the aio-move branch from 791bf39 to cb6d2b6 Compare February 9, 2017 19:32

googlebot added cla: yes and removed cla: no labels Feb 9, 2017

IgorMinar merged commit 600402d into angular:master Feb 9, 2017

petebacondarwin deleted the aio-move branch March 13, 2017 20:37

angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build(aio): big move of docs related files #14361

build(aio): big move of docs related files #14361

petebacondarwin commented Feb 8, 2017

petebacondarwin commented Feb 8, 2017

petebacondarwin commented Feb 8, 2017

wardbell commented Feb 8, 2017 •

edited

petebacondarwin commented Feb 8, 2017

gkalpak Feb 8, 2017

petebacondarwin Feb 8, 2017 •

edited

IgorMinar Feb 8, 2017

gkalpak Feb 8, 2017

petebacondarwin Feb 8, 2017

gkalpak Feb 8, 2017

petebacondarwin Feb 8, 2017

petebacondarwin Feb 8, 2017

gkalpak Feb 8, 2017

petebacondarwin Feb 8, 2017

IgorMinar left a comment

IgorMinar Feb 8, 2017

IgorMinar Feb 8, 2017

IgorMinar Feb 8, 2017

IgorMinar Feb 8, 2017

googlebot commented Feb 8, 2017

googlebot commented Feb 9, 2017

angular-automatic-lock-bot bot commented Sep 11, 2019

build(aio): big move of docs related files #14361

build(aio): big move of docs related files #14361

Conversation

petebacondarwin commented Feb 8, 2017

petebacondarwin commented Feb 8, 2017

petebacondarwin commented Feb 8, 2017

wardbell commented Feb 8, 2017 • edited

petebacondarwin commented Feb 8, 2017

Choose a reason for hiding this comment

petebacondarwin Feb 8, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IgorMinar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

googlebot commented Feb 8, 2017

googlebot commented Feb 9, 2017

angular-automatic-lock-bot bot commented Sep 11, 2019

wardbell commented Feb 8, 2017 •

edited

petebacondarwin Feb 8, 2017 •

edited