Skip to content

0.6.x docs - #335

Merged
lukemelia merged 18 commits into
gh-pagesfrom
gh-pages-0.6.x-first-pass
Jan 23, 2016
Merged

lukemelia merged 18 commits into
gh-pagesfrom
gh-pages-0.6.x-first-pass

Conversation

@lukemelia

Copy link
Copy Markdown
Contributor

@lukemelia lukemelia modified the milestones: 0.5.0, 0.6.x Dec 30, 2015
@lukemelia lukemelia changed the title Quick first pass at 0.6.x docs based on copy pasta of 0.5.x 0.6.x docs Jan 7, 2016
@lukemelia lukemelia changed the title 0.6.x docs [WIP] 0.6.x docs Jan 7, 2016
@lukemelia
lukemelia force-pushed the gh-pages-0.6.x-first-pass branch from 9f492fb to ff79560 Compare January 8, 2016 04:50
@lukemelia
lukemelia force-pushed the gh-pages-0.6.x-first-pass branch from 17dfc79 to 5373c84 Compare January 22, 2016 14:28
@lukemelia lukemelia changed the title [WIP] 0.6.x docs 0.6.x docs Jan 22, 2016
pablobm and others added 4 commits January 23, 2016 00:38
@samselikoff

Copy link
Copy Markdown
Contributor

Yall I went ahead and pushed some commits (mostly stylistic stuff), just to make things move faster. Please feel free to comment on anything I added.

@samselikoff

Copy link
Copy Markdown
Contributor

Hoping to have some more time this weekend to work through more sections.

@samselikoff

Copy link
Copy Markdown
Contributor

Hey all, I wrote some thoughts here about reorganizing the docs.

tl;dr, I think we can restructure things to make the project more approachable. Here's my proposed structure:


Getting started

  • Overview
  • Installation
  • Upgrade guide
  • Quick start

Setting up your pipeline

  • Determining needs
    • Explain that deploy pipelines tend to be unique. Explain common things to be aware of when formulating a deploy strategy. Recommend the lightening approach and explain why (speed, ability to preview and rollback).
  • Using plugins
    • Explain once you've identified your needs, next step is to configure your deploy pipline with plugins that accomplish these tasks. Briefly explain the pipeline, and the structure it provides. Explain that then, you should look for community plugins that provide the functionality you need. Describe configuration via deploy.js. Explain that only when you cannot find an existing plugin should you write your own. Give a short example of writing your own, with a link to a more comprehensive guide.
  • Deploying your app
    • Explain how to use ECD once your app has a configured pipeline. Explain deploying to different targets, activation, immediate activation, rollback, listing.
  • Plugin packs
    • Explain that after you have a set of plugins that work for your app, how keeping them in sync can be cumbsersome. Explain that plugin packs were created to solve this problem - a way to bundle up your whole configured pipeline into a single addon. Now new apps can use this addon and get all the registered functionality from each plugin within the pack.

Authoring plugins

  • Creating a plugin
  • Pipeline hooks
  • The deployment context
  • Creating a plugin pack

Cookbook

  • Default options for the deploy command
  • Using .env for secrets
  • Including a plugin twice
  • Development workflow

Reference

  • Configuration
  • Other API/Classes

Some other random thoughts:

  • We should use the "Plugins" route at the top of the site to list plugins and plugin packs, rather than a link within the docs. Maybe we can have a list that can filter on version, or just a few different child routes.
  • I don't think we need to document fingerprinting, I think it should be the responsibility of the S3 plugins to explain fingerprinting and point users to Ember CLI's docs.

Ok, let me know what you think!

lukemelia added a commit that referenced this pull request Jan 23, 2016
@lukemelia
lukemelia merged commit 1a840ca into gh-pages Jan 23, 2016
@lukemelia
lukemelia deleted the gh-pages-0.6.x-first-pass branch January 23, 2016 23:27
@lukemelia

Copy link
Copy Markdown
Contributor Author

@samselikoff Feel free to open a new issue to track the docs re-org.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants