Description
Thanks for your interest in helping with this project! We are porting over content from ember-cli.com, editing it, and writing new things. This project is part of an RFC
Choose a task, comment on this issue to say which section, then open an issue with the same name. The newly opened issue is the best place for Q&A about the task. Please read CONTRIBUTING.md before starting to write. Note that you should not have to create any new files. If you need help deciding where your content belongs, ask a question on the issue and @ me.
We will accept PRs that partially address topics, add comments with suggested content, or start to define subheadings within topics. Small PRs are awesome! The goal is to be quick to PR, quick to merge, and allow for some churn later on.
Note on respecting copyright - It is ok to copy/paste content over from ember-cli.com. It is not ok to copy and paste content that you didn't write that came from blog posts, articles, tutorials, etc. whether paid or free. Exceptions are if the license allows it or you have written permission of the author via a comment on an issue in this repo.
Goal - Ship by the end of November!
Open tasks that need volunteers:
- Pick a markdown file without content and add suggested headings (many people needed, name a subject and it's yours. Make it clear in your comment or issue name.)
- Update Asset Compilation
- Update Upgrading section (separate PR)
- Port over up-to-date sections of Blueprints. Remove/edit outdated content. Recommended for experienced addon authors.
- Go through developing addons and open an issue listing points missing from the Tutorial
- After the audit, PR the additions (should be very small, 5 sentences max)
- Write a section on including assets in addons - Greenfield, recommended for experienced writer/addon author.
- Write updating addons section in the "Upgrading" page
WIP tasks
- Port over Environments. Mostly copy and paste from this source code @ddoria921
Nice to Have
On hold (no volunteers needed yet)
- create a mapping of ember-cli.com pages to our urls
- End to end prose editing sweep after MVP is reached
- End to end technical review
- CI
- Staging deployment
- clean up some stylesheet quirks
- handle problems with incomplete urls
- alpha deployment to cli.emberjs.com
- implement redirects in ember-cli.com (after Jan 1st?)
- add cli team as maintainers for the github repo
Completed tasks
- align RFC topics with the table of contents/file structure - @jenweber
- write basic beginner content for using the CLI and making an addon - @jenweber
- app structure, deploy pipeline, scaffolding, etc - thank you so much @mansona
- Port over watchman instructions. Mostly copy and paste from this source code Improve watchman docs #4 @sandstrom, includes review and updates
- Port over Windows-specific instructions on ember-cli.com. Mostly copy and paste from this source code @Gaurav0 Port over Windows support #6
- Port over Editors. Mostly copy and paste from this source code @cah-danmonroe Port over Windows support #6
- Automated testing by @aklkv Feature/automation #9
- Port over Asset Compilation (unedited). Mostly copy and paste from this source code @Gaurav0 Port (but do not reorganize and edit) Asset Compilation #18
- Port over Common Issues. Mostly copy and paste from this source code @BradenLawrence Common issues transfer #12
- Port over Upgrading. Mostly copy and paste from this source code @DanMonroe Port over Upgrading #11
- Port over managing dependencies. Mostly copy and paste from this source code @BradenLawrence Port over managing dependencies #19
- Update or rewrite Managing Dependencies (a separate PR from above) @jenweber
- Rewrite Deployments - greenfield, recommended for experienced writers @jenweber