Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up[Quest Issue] All I want for Christmas is some documentation! #111
Comments
we might want to think about this in the context that we will want to upgrade to Babel 6 at some point in the hopefully near future.
I'm assuming you meant "Bower" here? |
|
I can do the babel configuration story. I've been developing with many features disabled (mostly because I hate debugging transpiled e-c generators) and I haven't found a single issue so far. |
IMO this is still too difficult.
I think |
My idea for a while has been to replace the current implementation of ember-watson, with jscodeshift -- so it will be only a wrapper to it. The amount of people using codeshift + docs give us a good starting point for something others can extend. Unfortunately, my bandwidth is pretty limited at the moment so I can't do it myself, but if someone can help, I'd be happy to give support as much as time allows. |
|
@martndemus I have updated your issue slightly, so that it is in the form a checklist. This should help track progress. Some of the ideas seem good, but for a quest issue they seems under specified. I have also created check marks to track those things. |
this is true, but requires its own RFC. Lots of little details that turn out to be tricky. |
The acceptance criteria for this issue is not terribly clear. Documentation does exist, but it is lacking some scenarios: https://ember-cli.com/extending/#developing-addons-and-blueprints an RFC or similar describing what would improve it would help make this actionable. |
|
@abuiles got any cycles re improving codemod docs, as you are the original master mind behind ember-watson you have have thoughts/ideas. |
|
Some quick features of ember-cli addons there is little or no documentation at ember-cli.com for:
|
|
I was trying to create my first ember addon and bumped into following points which where not clear on the docs: how to include depending addon:in one place docs say:
and in blueprints it says:
so what should I exactly do? is adding to package.json enough? or should I add it to the blueprint too? how to run blueprint on linked addononce docs say
but when I run the
then I try it with doing |
|
The key question is does your addon depend on another addon, i.e. does it |
|
Ok, currently I cant imagine a case where my addon depends on another but does not however I found out when I install my addon on a host application the blueprint of |
|
@mohamnag If you need the blueprint to run, use addAddonsToProject. I don't see |
|
it is not only for dummy app, it is for templates delivered by the addon itself. So I will add it to blueprint, but these information are still worth going into the docs. |
Hi all! I'd like to make Ember CLI's Christmas extra special by crowd sourcing some effort into documenting the various unknowns around Ember CLI.
Ember CLI is awesome. Broccoli, the main driving force behind Ember CLI is awesome too. Together they form the best CLI for managing and building browser JS projects in the world.
Sadly a lot of the awesome behind Ember CLI is very underdocumented or the documentation is very hard to find unless you know what you are looking for.
I'd like to try and do what @chancancode did for Glimmer 2 integration and see if a big centralized quest issue could motivate a group of people to concert effort into improving Ember CLI's documentation.
Here's my wishlist:
Ember CLI's documentation on this is very sparse, upgrading is quite a bit more involved than the Ember CLI website shows you. A more detailed guide would be very welcome.
Relevant project: ember-cli-babel
There is a little bit of documentation there, but could be expanded greatly. Things like how to turn on/off certain ES2015+ features transpilation could be improved. The documentation is also hard to discover, there is no mention of this in the official ember-cli.com docs.
Including Babel dependencies is quite well documented, but seeing there is a recent move of all dependencies to NPM, we could use some documentation on how to include dependencies from NPM.
People have been making code mods to migrate pieces of code. It would be amazing to have clear cut documentation on how to do this, as learning this skill is pretty much limited by copying code from other projects right now.
See:
https://github.com/abuiles/ember-watson
https://github.com/cibernox/ember-k-codemod
https://github.com/html-next/ember-hammertime
https://github.com/html-next/flexi
How to write Ember CLI addons / Broccoli Plugins.
There is some documentation for this, and you can find it if you search really hard for it. But it's scattered all over the place. It would be great if the documentation for this could be more findable and concentrated in a single place.
..... I'm sure I or someone else will think of another thing to add to the wishlist.
Please like, share and leave a comment below. Let's give @stefanpenner an extra special Christmas!