Skip to content
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.

Sign up for GitHub

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

Jump to bottom

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

Closed
27 of 32 tasks
jenweber opened this issue Sep 30, 2018 · 11 comments
Closed
27 of 32 tasks

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

jenweber opened this issue Sep 30, 2018 · 11 comments

Comments

@jenweber
Copy link
Contributor

jenweber commented Sep 30, 2018 •
edited
Loading

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
@jenweber jenweber changed the title Quest - write the MVP of new ember-cli-guides DRAFT Quest - write the MVP of new ember-cli-guides Sep 30, 2018
@jenweber jenweber changed the title DRAFT Quest - write the MVP of new ember-cli-guides Quest - write the MVP of new ember-cli-guides Oct 1, 2018
@sandstrom
Copy link

sandstrom commented Oct 1, 2018 •
edited
Loading

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

@cah-danmonroe
Copy link
Contributor

I'll take a look at porting Editors

@Gaurav0 Gaurav0 mentioned this issue Oct 2, 2018
Merged
@Gaurav0
Copy link
Contributor

Gaurav0 commented Oct 2, 2018

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

@cah-danmonroe cah-danmonroe mentioned this issue Oct 2, 2018
Merged
@BradenLawrence
Copy link
Contributor

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

@cah-danmonroe
Copy link
Contributor

I'll do Port over Upgrading.

BradenLawrence added a commit to BradenLawrence/cli-guides-source that referenced this issue Oct 4, 2018
@BradenLawrence
Add common issues markdown from ember-cli.com
1565329 
 - 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
@BradenLawrence BradenLawrence mentioned this issue Oct 4, 2018
Merged
@Gaurav0 Gaurav0 mentioned this issue Oct 7, 2018
Merged
@ddoria921
Copy link

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

@BradenLawrence
Copy link
Contributor

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

@ddoria921
Copy link

@BradenLawrence I started on that one yesterday 😄

jenweber pushed a commit that referenced this issue Oct 11, 2018
@BradenLawrence
Common issues transfer (#12)
b3d01d2 
* 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
Copy link
Contributor

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

BradenLawrence added a commit to BradenLawrence/cli-guides-source that referenced this issue Oct 11, 2018
@BradenLawrence
Add managing dependancies markdown, taken from ember-cli.com
e2d0749 
 - Addressing issue ember-learn#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
@BradenLawrence BradenLawrence mentioned this issue Oct 11, 2018
Merged
jenweber pushed a commit that referenced this issue Oct 11, 2018
@BradenLawrence
Port over managing dependencies (#19)
9fa01d3 
* 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 mentioned this issue Oct 11, 2018
Merged
13 tasks
@jenweber jenweber mentioned this issue Nov 10, 2018
Closed
5 tasks
@maxwondercorn
Copy link
Contributor

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 pushed a commit that referenced this issue Nov 25, 2018
@maxwondercorn
#3 blueprints (#38)
d58141c 
* #3 blueprints

* added addon blueprint info

* dropped  rexport details from __root__ - too detailed for guide

* Add many backticks and a couple wording changes

* resolve json parsing error

* Add hook and destroy to alex linting ignore
@jenweber
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@sandstrom @Gaurav0 @ddoria921 @cah-danmonroe @jenweber @BradenLawrence @maxwondercorn