ember-learn/cli-guides

Quest - write the MVP of new ember-cli-guides

jenweber opened this issue · 11 comments

jenweber commented

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

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

sandstrom commented

I've reviewed, updated the language and ported Watchman instructions: #4

cah-danmonroe commented

I'll take a look at porting Editors

Gaurav0 commented

I've made a PR for port over Windows support (#6).

BradenLawrence commented

I'll start working on:
"Port over Common Issues. Mostly copy and paste from this source code"

cah-danmonroe commented

I'll do Port over Upgrading.

ddoria921 commented

I'll work on:
"Port over Environments. Mostly copy and paste from this source code"

BradenLawrence commented

Taking this one next:
"Port over Environments. Mostly copy and paste from this source code"

ddoria921 commented

@BradenLawrence I started on that one yesterday 😄

BradenLawrence commented

So you did! Sorry I missed that. Taking this one instead:
"Port over managing dependencies. Mostly copy and paste from this source code"

maxwondercorn commented

I'm starting to work on blueprints. I maintain a few addons, but someone with more experience than may need to flush it out after I'm done

jenweber commented

Good news, everyone! We have reached MVP and the launch is scheduled for Monday, November 26th! Tomorrow, the content will become available at https://cli.emberjs.com. Thank you so much for all your work ❤️

The next phase for this project will focus on resources for addon developers. We will also implement redirects from the old CLI site, and add links to this site from many places. If you would like to help, keep an eye out for new issues on this project.

Closed with release of 1.0

  • 🎉3