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

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

Open
jenweber opened this Issue Sep 30, 2018 · 9 comments

Comments

Projects
None yet
6 participants
@jenweber
Contributor

jenweber commented Sep 30, 2018

Thanks for your interest in helping with this project! We are porting over content from ember-cli.com, editing it, and writing new things. The RFC will most likely be merged later this week, so we are beginning to build the writing team.

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 - MVP by the end of 2018

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 or rewrite Managing Dependencies (a separate PR from above)
  • Rewrite Deployments - greenfield, recommended for experienced writers
  • 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.

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

@jenweber jenweber changed the title from Quest - write the MVP of new ember-cli-guides to DRAFT Quest - write the MVP of new ember-cli-guides Sep 30, 2018

@jenweber jenweber changed the title from DRAFT Quest - write the MVP of new ember-cli-guides to Quest - write the MVP of new ember-cli-guides Oct 1, 2018

@sandstrom

This comment has been minimized.

Show comment
Hide comment
@sandstrom

sandstrom Oct 1, 2018

Contributor

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

Contributor

sandstrom commented Oct 1, 2018

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

@cah-danmonroe

This comment has been minimized.

Show comment
Hide comment
@cah-danmonroe

cah-danmonroe Oct 2, 2018

Contributor

I'll take a look at porting Editors

Contributor

cah-danmonroe commented Oct 2, 2018

I'll take a look at porting Editors

@Gaurav0

This comment has been minimized.

Show comment
Hide comment
@Gaurav0

Gaurav0 Oct 2, 2018

Contributor

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

Contributor

Gaurav0 commented Oct 2, 2018

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

@BradenLawrence

This comment has been minimized.

Show comment
Hide comment
@BradenLawrence

BradenLawrence Oct 4, 2018

Contributor

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

Contributor

BradenLawrence commented Oct 4, 2018

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

@cah-danmonroe

This comment has been minimized.

Show comment
Hide comment
@cah-danmonroe

cah-danmonroe Oct 4, 2018

Contributor

I'll do Port over Upgrading.

Contributor

cah-danmonroe commented Oct 4, 2018

I'll do Port over Upgrading.

BradenLawrence pushed a commit to BradenLawrence/cli-guides-source that referenced this issue Oct 4, 2018

blip
Add common issues markdown from ember-cli.com
 - Addressing issue ember-learn#3, item 10, "Port over Common Issues. Mostly copy and paste from this source code"
 - Converted the markdown file found here: https://raw.githubusercontent.com/ember-cli/ember-cli.github.io/master/_posts/2013-04-03-common-issues.md
@ddoria921

This comment has been minimized.

Show comment
Hide comment
@ddoria921

ddoria921 Oct 10, 2018

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

ddoria921 commented Oct 10, 2018

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

@BradenLawrence

This comment has been minimized.

Show comment
Hide comment
@BradenLawrence

BradenLawrence Oct 11, 2018

Contributor

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

Contributor

BradenLawrence commented Oct 11, 2018

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

@ddoria921

This comment has been minimized.

Show comment
Hide comment
@ddoria921

ddoria921 Oct 11, 2018

@BradenLawrence I started on that one yesterday 😄

ddoria921 commented Oct 11, 2018

@BradenLawrence I started on that one yesterday 😄

jenweber added a commit that referenced this issue Oct 11, 2018

Common issues transfer (#12)
* Add common issues markdown from ember-cli.com
 - Addressing issue #3, item 10, "Port over Common Issues. Mostly copy and paste from this source code"
 - Converted the markdown file found here: https://raw.githubusercontent.com/ember-cli/ember-cli.github.io/master/_posts/2013-04-03-common-issues.md

* Update internal link to the Windows Support section

* Modify common-issues.md content per @sandstrom's suggestions
 - Clarify the heading for the npm packages section
 - Add a description for the Canary build section
 - Remove PhantomJS section
 - Fix the link to Vagrant to include https

* Remove references to PhantomJS in the Docker section
 - Commenting out Docker section until it can be rewritten without using PhantomJS
@BradenLawrence

This comment has been minimized.

Show comment
Hide comment
@BradenLawrence

BradenLawrence Oct 11, 2018

Contributor

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

Contributor

BradenLawrence commented Oct 11, 2018

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

BradenLawrence pushed a commit to BradenLawrence/cli-guides-source that referenced this issue Oct 11, 2018

jenweber added a commit that referenced this issue Oct 11, 2018

Port over managing dependencies (#19)
* Add common issues markdown from ember-cli.com
 - Addressing issue #3, item 10, "Port over Common Issues. Mostly copy and paste from this source code"
 - Converted the markdown file found here: https://raw.githubusercontent.com/ember-cli/ember-cli.github.io/master/_posts/2013-04-03-common-issues.md

* Update internal link to the Windows Support section

* Modify common-issues.md content per @sandstrom's suggestions
 - Clarify the heading for the npm packages section
 - Add a description for the Canary build section
 - Remove PhantomJS section
 - Fix the link to Vagrant to include https

* Remove references to PhantomJS in the Docker section
 - Commenting out Docker section until it can be rewritten without using PhantomJS

* Add managing dependancies markdown, taken from ember-cli.com
 - Addressing issue #3, "Port over managing dependencies."
 - Converted the markdown file found here: https://raw.githubusercontent.com/ember-cli/ember-cli.github.io/master/_posts/2013-04-08-managing-dependencies.md

@tylerturdenpants tylerturdenpants referenced this issue Oct 11, 2018

Merged

Ember Times Issue 68 #3614

9 of 13 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment