Tracking: Documentation

[Brocco]

Document the following areas of the CLI:

• overview
• new
• init
• generate
  • component
  • class
  • directive
  • enum
  • interface
  • module
  • pipe
  • service
• test
• build
• e2e
• get/set
• docs
• eject
• lint
• serve
• angular-cli.json

Tasks:

• Move readme documentation to the wiki (docs)

Stories for more details:

• Setup AngularFire (PR - chore(docs): add documentation to integrate AngularFire (WIP) #3931)
• Include bootstrap with CSS
• Include Font Awesome (PR - chore(docs): add how-to for Font Awesome inclusion #3898)
• Setup of global styles
• Setup bootstrap with SASS (PR - docs: update bootstrap documentation to include SASS #4067)
• Setup Angular Material 2 (PR - chore(docs): add how-to's for angular material inclusion #3897)
• Setup Angular FlexLayout (PR - chore(docs): add flex-layout directions #4096)
• Configure package manager (Issue - Tracking: Third party NPM replacements #3886)
• Deployment steps (Firebase/Github)
• Setting up preprocessor paths (ref PR feat(build): add style paths #4003)

Nice to have:

• Setup project with asp.net core asp.net core with angular CLI #3578

Additional:

• Internationalization usage/story;
  • extraction
  • build
  • serve
  • deploy

[Puigcerber]

Hey guys!

I thought about this yesterday when I discovered that all the generate commands have many options. Any idea of where to start? README.md or a separate guide?

Cheers.

[Brocco]

Still trying to figure that out for now, wanted to have a placeholder issue to track against.

[elvirdolic]

It would be great to put more docs to https://cli.angular.io/ with similiar doc style which is used on angular.io

[hansl]

Next action item:

• Move the WIKI content to /docs/wiki in the repo. The release should publish the wiki from git.

[Meet91]

Following this updated doc to integrate Bootstrap with angular-cli results into following module conflicts:

jquery.js
tether.js
Details errors are as below:

**ERROR in multi scripts
Module not found: Error: Can't resolve 'C:\word\angular-demo\node_modules\jquery\dist\jquery.js' in 'C:\word\angular-demo\node_modules\angular-cli\models'
@ multi scripts

ERROR in multi scripts
Module not found: Error: Can't resolve 'C:\word\angular-demo\node_modules\tether\dist\js\tether.js' in 'C:\word\angular-demo\node_modules\angular-cli\models'
@ multi scripts**

I'm using below configuration:
angular-cli: 1.0.0-beta.20-4
node: 7.1.0(npm-4.0.3)
os: win32 x64
bootstrap : 3.3.7

Any help in this matter would be really appreciated!

Thanks,
Mitesh

[Brocco]

@Meet91 I just verified my local app with no issues. Based upon your errors it seems like you're attempting to pull in more than just the bootstrap CSS as my guide suggests. If that's not the case please create a separate issue on this repo or post a question on StackOverflow. Make sure to either tag me in the issue and/or link to it here so I can find it. (I don't have a windows environment setup, so I'm testing on macOS v10.12.1)

[nweldev]

@Meet91 see #3202 (comment), there is a workaround for that

Edit : see #3202 (comment) ... the problem seems to be resolved in beta.22-1

[Meet91]

@noelmace I updated the angular-cli to beta.22-1 and error goes away and also tested with the bootstrap integration and all works great...Thank you so much for responding on such a short period!!!

[jeremymwells]

@Brocco - can you elaborate a little bit on what you had in mind for Setup of global styles?

[Brocco]

@jeremymwells global styles are the style files referenced via angular-cli.json this would be an overview of:

1. how to setup a reference here
2. an overview of the implications of setting up a style here versus within an individual component

This is not meant to be a complicated explanation, just an overview on how to achieve application-wide styling.

[filipesilva]

@Brocco added angular-cli.json to the list.

[moniuch]

I would appreciate if angular-cli docs were constantly updated with minimum requirements of relevant dependencies, for each release.

[hansl]

I need to work on a serializer of the documentation for hte JSON Schema.

[hansl]

Considering this done. Expect more stories post 1.0.

@moniuch that's a great idea, but we're pretty lax on our requirements. The only relevant dependency is Angular and TypeScript :)

[itsnotvalid]

There is a mismatch to protrator.conf.json that the project line is not e2e but e2e/tsconfig.e2e.json from the generator output.

beforeLaunch: function() {
    require('ts-node').register({
      project: 'e2e/tsconfig.e2e.json'
    });
  },

[mtpultz]

Is there any reference to Setup of global styles that can be subscribed to on GitHub?

[mtpultz]

Found this in the docs https://github.com/angular/angular-cli/blob/master/docs/documentation/stories/global-styles.md, but I think what I meant by global styles was a way to add global Sass variables for use with components during compile. Otherwise, you're always importing a variables file, palette file, etc throughout your Sass files.

[angular-automatic-lock-bot]

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