Skip to content

Tracking: Documentation #2711

Description

@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:

Nice to have:

Additional:

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

Activity

  1. self-assigned this
    on Oct 14, 2016
  2. Puigcerber commented on Oct 14, 2016

    @Puigcerber
    Contributor

    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.

  3. added
    P1Impacts a large percentage of users; if a workaround exists it is partial or overly painful
    area: docsRelated to the documentation
    on Oct 15, 2016
  4. Brocco commented on Oct 15, 2016

    @Brocco
    ContributorAuthor

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

  5. elvirdolic commented on Oct 15, 2016

    @elvirdolic

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

  6. changed the title [-]Improve documentation[/-] [+]Tracking: Documentation[/+] on Nov 18, 2016
  7. hansl commented on Dec 2, 2016

    @hansl
    Contributor

    Next action item:

    • Move the WIKI content to /docs/wiki in the repo. The release should publish the wiki from git.
  8. Meet91 commented on Dec 6, 2016

    @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

  9. Brocco commented on Dec 7, 2016

    @Brocco
    ContributorAuthor

    @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)

  10. nweldev commented on Dec 7, 2016

    @nweldev
    Contributor

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

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

  11. Meet91 commented on Dec 7, 2016

    @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!!!

  12. 19 remaining items

  13. filipesilva commented on Jan 24, 2017

    @filipesilva
    Contributor

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

  14. moniuch commented on Feb 27, 2017

    @moniuch

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

  15. self-assigned this
    on Mar 16, 2017
  16. hansl commented on Mar 16, 2017

    @hansl
    Contributor

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

  17. added this to the milestone on Mar 16, 2017
  18. hansl commented on Mar 24, 2017

    @hansl
    Contributor

    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 :)

  19. itsnotvalid commented on Mar 27, 2017

    @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'
        });
      },
  20. mtpultz commented on Jul 18, 2017

    @mtpultz

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

  21. mtpultz commented on Jul 18, 2017

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

  22. angular-automatic-lock-bot commented on Sep 7, 2019

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

  23. locked and limited conversation to collaborators on Sep 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P1Impacts a large percentage of users; if a workaround exists it is partial or overly painfularea: docsRelated to the documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions