cli-guides icon indicating copy to clipboard operation
cli-guides copied to clipboard

Add Broccoli basics to guides

Open MelSumner opened this issue 6 years ago • 11 comments

With the Broccoli 2.0 implementation complete, we should ensure that there is an MVP for documentation in the guides. In addition to a basic introduction, the guides can link to the more extensive Broccoli documentation.

This issue is part of the Octane Edition of Ember.js.

MelSumner avatar Nov 28 '18 05:11 MelSumner

https://broccoli.build https://github.com/broccolijs/broccoli

Working on getting started https://github.com/broccolijs/broccolijs.github.io/pull/1 guide and then an "about/thinking in broccoli" guide to cover the basic and the core concepts.

oligriffiths avatar Dec 06 '18 16:12 oligriffiths

@oligriffiths just checking in - any updates? thank you! 👍

MelSumner avatar Jan 30 '19 17:01 MelSumner

@MelSumner waiting for feedback on https://github.com/broccolijs/broccolijs.github.io/pull/2

oligriffiths avatar Jan 30 '19 18:01 oligriffiths

Hi @oligriffiths - are there any blockers I can help with?

MelSumner avatar Feb 19 '19 20:02 MelSumner

@MelSumner If you'd like to look at https://github.com/broccolijs/broccolijs.github.io/pull/2 and working on some WIP documentation on plugin authorship https://github.com/broccolijs/broccolijs.github.io/pull/8

oligriffiths avatar Feb 19 '19 20:02 oligriffiths

@oligriffiths just sent in some feedback there, what else do you think we need on this issue?

acorncom avatar Mar 12 '19 11:03 acorncom

Per discussions with @MelSumner just now, we're envisioning that this would be a few simple paragraphs explaining a little about Broccoli with a link over the main Broccoli site.

I'll aim to work on this on March 18th, but if someone has umph beforehand, please, pick it up! 😄

acorncom avatar Mar 14 '19 16:03 acorncom

https://broccoli.build is the site.

got some plugin docs nearly ready https://github.com/broccolijs/broccolijs.github.io/pull/8 and I'm working on something for the guides that explain the addon hooks and how to integrate those with the build pipeline and broccoli plugins

oligriffiths avatar Mar 14 '19 16:03 oligriffiths

@oligriffiths sweet 🎉 I'm drowning in Github notifications atm, but if you want a second pair of eyes to make sure that gets merged quickly, feel free to ping me on Discord.

acorncom avatar Mar 14 '19 18:03 acorncom

@oligriffiths we're almost finished with all things Octane- do you think you could get a PR into the official guides soon? Thank you for working on this!

MelSumner avatar Dec 03 '19 16:12 MelSumner

@oligriffiths any update here?

villander avatar Dec 29 '21 17:12 villander