Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

docs(cli-quickstart): add cli-quickstart chapter #1241

Closed
wants to merge 2 commits into from

Conversation

filipesilva
Copy link
Contributor

@filipesilva filipesilva commented May 2, 2016

This PR includes both the Angular-CLI quickstart chapter and e2e test support for CLI applications.

It does not add the CLI-Quickstart to the sidebar menu though, nor live example via plunker.

To run e2e tests for CLI applications, you must have Angular-CLI installed globally and using the same version as specified in public/docs/_examples/package.json.

When adding a new CLI-based chapter, create a project using ng new chapter-name and copy the contents of the chapter-name dir onto public/docs/_examples/chapter-name/ts/.

Afterwards, add an example-config.js in the example project root, rename package.json to package.1.json, remove declare var module: { id: string }; from src/typings.d.ts (angular.io typings already include node).

Finally, add public/docs/_examples/chapter-name/e2e-spec.js as usual.

@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

1 similar comment
@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

@googlebot
Copy link

CLAs look good, thanks!

1 similar comment
@googlebot
Copy link

CLAs look good, thanks!

@googlebot googlebot added CLA: yes and removed CLA: no labels May 2, 2016
@filipesilva
Copy link
Contributor Author

@wardbell I incorporated your changes and removed the verbose sections.

Before this is merged, the CLI should be updated to new world and the example app re-generated. After that, docregions need to be re-added.

@wardbell
Copy link
Contributor

Still holding out for your approval

@filipesilva filipesilva force-pushed the cli-quickstart branch 2 times, most recently from b4166da to 30db72c Compare May 19, 2016 01:02
@filipesilva filipesilva changed the title docs(cli-quickstart): add cli-quickstart chapter [WIP] docs(cli-quickstart): add cli-quickstart chapter May 19, 2016
@filipesilva
Copy link
Contributor Author

@wardbell PR is updated and ready. Description of PR also updated to reflect all changes and CLI chapter creation instructions.

@wardbell wardbell force-pushed the cli-quickstart branch 3 times, most recently from 18da809 to be0f2ed Compare May 20, 2016 06:34
The Angular-CLI build steps create symlinks which require administrator rights under Windows.

:marked
Now we're ready to write some code... or are we? We certainly could start writing code right now, but our tests would break.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we or are we? Sounds weird for me.

@Foxandxss
Copy link
Member

I reviewed it. All the steps works good on a new node environment, including the deploy thing.

Leaving this aside, I thought this cookbook was a replacement for the actual 5 min quickstart and not just a quickstart on CLI.

As a cookbook in how to get started on the CLI is good, but we still need a replica of the "5 min quickstart" but using the CLI. Same content, same things to add, but using the CLI.

I find a bit confusing (or verbose) having to update both e2e and unit tests (which makes sense, but still verbose for the reader). Would be good if different changes could be made so both tests would need different set of changes.

On the other hand, do we really need a whole set of instructions of how to set github? I would personally add a subsection on "Learn more in how to set a token here"

Can't wait to have the CLI in more places, I love how simple it is.

@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

1 similar comment
@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

@Foxandxss
Copy link
Member

Won't close this because I still need to extract a CB from here and I don't want the branch to be removed by mistake.

@Foxandxss Foxandxss closed this Jul 25, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants