Skip to content

Angular cli readme instructions #2260

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

Conversation

TomDemulierChevret
Copy link
Contributor

Features, Bug fixes, and others:

This pull request add instructions on how to use plotly.js in an Angular application built with Angular CLI.

@etpinard
Copy link
Contributor

Thanks for the info.

My only concern is this might make the README too long. Perhaps we could wrap this info in a <details> block?

@TomDemulierChevret
Copy link
Contributor Author

Or maybe merge the whole Modules section with dist/README.md into a file dedicated to building & bundling the library ?

The locales section of dist/README.md would need an update too, since setup described works only if you include plotly.js as a global script.
Plus, it doesn't allow the user to customise the locales (which is really easy if you include locale data in more modular maner).

@alexcjohnson
Copy link
Collaborator

Or maybe merge the whole Modules section with dist/README.md into a file dedicated to building & bundling the library ?

I like the idea of pulling build info out into a separate file. I'd leave dist/README.md as it is, since it's all about the pre-built, ready-to-use files, and I'd leave the note/link about partial bundles in the main readme (might even reorganize to bring that and the CDN links a little higher up, but that's a separate issue). But a separate file on making custom builds and using them with various pipelines would be great, then we can go into all necessary details without getting people bogged down while they're perusing the top-level readme. How about just /BUILDING.md?

@etpinard
Copy link
Contributor

etpinard commented Feb 5, 2018

I also would prefer leaving this new piece of document out of dist/README.md.

Personally, I'd vote for putting in the root REAMDE.md under a new section called Building or Bundling possibly using <details>.

@fhurta
Copy link
Contributor

fhurta commented Feb 6, 2018

Just a note to the sample - as scatter is included in core, maybe there could be some other sample (or the extra line removed).

"compilerOptions": {
    "paths": {
        "plotly.js": [
            "../node_modules/plotly.js/lib/core.js",
            "../node_modules/plotly.js/lib/scatter.js"
        ]
    }
}

@etpinard
Copy link
Contributor

done in #2654

@etpinard etpinard closed this May 23, 2018
@TomDemulierChevret TomDemulierChevret deleted the angular-&-angular-cli-readme-instructions branch November 30, 2018 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants