Skip to content

Commit

Permalink
Check off some charter methods for fun
Browse files Browse the repository at this point in the history
  • Loading branch information
Sashko Stubailo committed Dec 17, 2015
1 parent 3f1180c commit b4f271a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions charter.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ Let's get on the path to having a “Meteor Guide” – the most authoritative,

### **Methods**

1. Put the guide in a new repository so that it can be discussed and contributed to independently of the Meteor framework.
2. Set up a standard static site generator that will be easy for people to understand and contribute to.
3. Set up a continuous deployment system to automatically deploy changes from GitHub, so that we can't forget to deploy a new version.
4. Build in support for versioning docs via branches so that people can easily access documentation for previous Meteor releases.
1. :white_check_mark: Put the guide in a new repository so that it can be discussed and contributed to independently of the Meteor framework.
2. :white_check_mark: Set up a standard static site generator that will be easy for people to understand and contribute to.
3. :white_check_mark: Set up a continuous deployment system to automatically deploy changes from GitHub, so that we can't forget to deploy a new version.
4. :white_check_mark: Build in support for versioning docs via branches so that people can easily access documentation for previous Meteor releases.
5. Ensure great SEO so that people can find documentation items through Google or other search engines.
6. Don't put guide-appropriate information anywhere else, like the GitHub Wiki, READMEs, or similar, so that people don't have to guess where information might be hidden.
7. Make contributing to the guide the easiest way to contribute to the Meteor project, by adding “edit this page” buttons everywhere.
7. :white_check_mark: Make contributing to the guide the easiest way to contribute to the Meteor project, by adding “edit this page” buttons everywhere.
8. Be proactive in evaluating and accepting community contributions.
9. Be clear about why contributions are and are not accepted, and write these down in a living document about how to craft a great contribution to the guide.
10. Hire a technical writer to help efficiently produce great content and ensure everything is nice to read, consistent in style, and free of grammatical errors or stylistic issues.
11. Organize guide content by developer goals rather than API methods. It's possible that some sections will lack Meteor API information entirely, if the Meteor API doesn't help with any of those goals. API documentation is a separate app we'll need to built some other time.
12. Put community packages and MDG packages on a more even footing by sometimes endorsing the community solution over the MDG one when it's better.
11. :white_check_mark: Organize guide content by developer goals rather than API methods. It's possible that some sections will lack Meteor API information entirely, if the Meteor API doesn't help with any of those goals. API documentation is a separate app we'll need to built some other time.
12. :white_check_mark: Put community packages and MDG packages on a more even footing by sometimes endorsing the community solution over the MDG one when it's better.
13. Figure out a way to user test the guide to see if it helps developers achieve their goals.
14. Loop in every framework developer to get input on the parts of the framework with which they are most familiar.
15. Add a section to each article that has related links that people can submit - for example links to packages that people have written to help with a certain task, or how-to articles on someone's blog. Heading could be “other articles on the web”.
Expand All @@ -44,10 +44,10 @@ Let's get on the path to having a “Meteor Guide” – the most authoritative,

### **Goals**

1. Develop a skeleton for a guide app, with nice styles and a clear path to adding more content [firm]
2. Have continuous deployment set up for at least two branches of the new guide repository [firm]
1. :white_check_mark: Develop a skeleton for a guide app, with nice styles and a clear path to adding more content [firm]
2. :white_check_mark: Have continuous deployment set up for at least two branches of the new guide repository [firm]
3. Migrate all existing content onto the guide website from docs.meteor.com, GitHub Wiki, and READMEs (I'm looking at you, Spacebars) [firm]
4. Hire one technical writer
5. Have an “edit on GitHub” button on every single page
5. :white_check_mark: Have an “edit on GitHub” button on every single page
6. Review every guide contribution within one week of submission and give a conclusive response
7. Accept 50 community pull requests

0 comments on commit b4f271a

Please sign in to comment.