[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-08-28 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using 

[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-07-12 Thread Nick Veitch
Blueprint changed by Nick Veitch:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [marcoceppi] Prepare rollout strategy for new docs launch: DONE
  [marcoceppi] Propose policy for inclusion of doc contributions as ~charmers 
contrib: TODO
  [jorge] Streamline contributions process in documentation: TODO
- [evilnick] Create video/webinar strategy: TODO
+ [evilnick] Create video/webinar strategy: DONE
  [mark-mims] Testing structure for charm documentation: TODO
  [marcoceppi] Auto-generate charm interfaces documentation: TODO
  [jorge] : Make sure our docs are synced on readthedocs.org: TODO
  [jorge] Migrate/Move documentation embedded in juju.ubuntu.com into 
juju.ubuntu.com/docs (getting started, and community).: TODO
  [a.rosales] Get a beta site going for Juju docs.: TODO
  [a.rosales] Get a permanent staging site for the docs: TODO
  [jorge] Get UX testing on the docs: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-07-11 Thread Marco Ceppi
Blueprint changed by Marco Ceppi:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
- [marcoceppi] Prepare rollout strategy for new docs launch: TODO
+ [marcoceppi] Prepare rollout strategy for new docs launch: DONE
  [marcoceppi] Propose policy for inclusion of doc contributions as ~charmers 
contrib: TODO
  [jorge] Streamline contributions process in documentation: TODO
  [evilnick] Create video/webinar strategy: TODO
  [mark-mims] Testing structure for charm documentation: TODO
  [marcoceppi] Auto-generate charm interfaces documentation: TODO
  [jorge] : Make sure our docs are synced on readthedocs.org: TODO
  [jorge] Migrate/Move documentation embedded in juju.ubuntu.com into 
juju.ubuntu.com/docs (getting started, and community).: TODO
  [a.rosales] Get a beta site going for Juju docs.: TODO
  [a.rosales] Get a permanent staging site for the docs: TODO
  [jorge] Get UX testing on the docs: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-16 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using 

[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-16 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [marcoceppi] Prepare rollout strategy for new docs launch: TODO
  [marcoceppi] Propose policy for inclusion of doc contributions as ~charmers 
contrib: TODO
  [jorge] Streamline contributions process in documentation: TODO
  [evilnick] Create video/webinar strategy: TODO
  [mark-mims] Testing structure for charm documentation: TODO
  [marcoceppi] Auto-generate charm interfaces documentation: TODO
  [jorge] : Make sure our docs are synced on readthedocs.org: TODO
+ [jorge] Migrate/Move documentation embedded in juju.ubuntu.com into 
juju.ubuntu.com/docs (getting started, and community).: TODO
+ [a.rosales] Get a beta site going for Juju docs.: TODO
+ [a.rosales] Get a permanent staging site for the docs: TODO
+ [jorge] Get UX testing on the docs: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-15 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [marcoceppi] Prepare rollout strategy for new docs launch: TODO
  [marcoceppi] Propose policy for inclusion of doc contributions as ~charmers 
contrib: TODO
  [jorge] Streamline contributions process in documentation: TODO
  [evilnick] Create video/webinar strategy: TODO
  [mark-mims] Testing structure for charm documentation: TODO
  [marcoceppi] Auto-generate charm interfaces documentation: TODO
+ [jorge] : Make sure our docs are synced on readthedocs.org: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-10 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using 

[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-10 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
  [evilnick] Recirculate video template specs: TODO
  [jorge] Find out who will redub our stuff: TODO
  [jorge] How to contribute to Juju docs section, make sure it follow's 
nick's style guide: TODO
  [marcoceppi] Propose to list to allow contributions to docs to count as 
~charmers contribution: TODO
  [marcoceppi] Investigate adding a chapter todo to the review queue: TODO
  [jorge] Update AU questions to point to newdocs: TODO
  [marcoceppi] Update AU questions to point to newdocs: TODO
+ [mark-mims] Investigate making charm documentation testable: TODO
+ [evilnick] Investigate making charm documentation testable: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-10 Thread Mark Mims
Blueprint changed by Mark Mims:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using 

[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-10 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
  [evilnick] Recirculate video template specs: TODO
  [jorge] Find out who will redub our stuff: TODO
  [jorge] How to contribute to Juju docs section, make sure it follow's 
nick's style guide: TODO
  [marcoceppi] Propose to list to allow contributions to docs to count as 
~charmers contribution: TODO
  [marcoceppi] Investigate adding a chapter todo to the review queue: TODO
  [jorge] Update AU questions to point to newdocs: TODO
  [marcoceppi] Update AU questions to point to newdocs: TODO
- [mark-mims] Investigate making charm documentation testable: TODO
- [evilnick] Investigate making charm documentation testable: TODO
+ [marcoceppi] Auto-generate charm interfaces documentation: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-10 Thread Marco Ceppi
Blueprint changed by Marco Ceppi:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
- [evilnick] Create list of screencasts: TODO
- [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
- [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
- [mark-mims] Script diffs to CLI: TODO
- [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
- [evilnick] Recirculate video template specs: TODO
- [jorge] Find out who will redub our stuff: TODO
- [jorge] How to contribute to Juju docs section, make sure it follow's 
nick's style guide: TODO
- [marcoceppi] Propose to list to allow contributions to docs to count as 
~charmers contribution: TODO
- [marcoceppi] Investigate adding a chapter todo to the review queue: TODO
- [jorge] Update AU questions to point to newdocs: TODO
- [marcoceppi] Update AU questions to point to newdocs: TODO
+ [marcoceppi] Prepare rollout strategy for new docs launch: TODO
+ [marcoceppi] Propose policy for inclusion of doc contributions as ~charmers 
contrib: TODO
+ [jorge] Streamline contributions process in documentation: TODO
+ [evilnick] Create video/webinar strategy: TODO
+ [mark-mims] Testing structure for charm documentation: TODO
  [marcoceppi] Auto-generate charm interfaces documentation: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Nick Veitch
Blueprint changed by Nick Veitch:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using 

[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
+ [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
+ [mark-mims] Script diffs to CLI: TODO
+ [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
+ [evilnick] Recirculate video template specs: TODO
+ [jorge] Find out who will redub our stuff: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
  [evilnick] Recirculate video template specs: TODO
  [jorge] Find out who will redub our stuff: TODO
+ [jorge] How to contribute to Juju docs section: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
  [evilnick] Recirculate video template specs: TODO
  [jorge] Find out who will redub our stuff: TODO
- [jorge] How to contribute to Juju docs section: TODO
+ [jorge] How to contribute to Juju docs section, make sure it follow's 
nick's style guide: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
  [evilnick] Recirculate video template specs: TODO
  [jorge] Find out who will redub our stuff: TODO
  [jorge] How to contribute to Juju docs section, make sure it follow's 
nick's style guide: TODO
+ [marcoceppi] Propose to list to allow contributions to docs to count as 
~charmers contribution: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-08 Thread Jorge O. Castro
Blueprint changed by Jorge O. Castro:

Work items changed:
  Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO
  [marcoceppi] Ensure URL rewrites work from olddocs to newdocs: TODO
  [mark-mims] Script diffs to CLI: TODO
  [evilnick] Publish list of videos and assign them to jorge, marco, mims, 
antonio, and whoever.: TODO
  [evilnick] Recirculate video template specs: TODO
  [jorge] Find out who will redub our stuff: TODO
  [jorge] How to contribute to Juju docs section, make sure it follow's 
nick's style guide: TODO
  [marcoceppi] Propose to list to allow contributions to docs to count as 
~charmers contribution: TODO
+ [marcoceppi] Investigate adding a chapter todo to the review queue: TODO
+ [jorge] Update AU questions to point to newdocs: TODO
+ [marcoceppi] Update AU questions to point to newdocs: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-07 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Work items changed:
  Work items for ubuntu-13.04-month-6:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
- [jorge] Develop screen casts based on defined list: TODO
+ [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-07 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Work items changed:
- Work items for ubuntu-13.04-month-6:
+ Work items:
  [evilnick] Define structural elements of HTML5 doc: DONE
  [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop Webinar/Screen cast education series mapped to Docs. (ie 12 
sessions from getting started to Debugging): TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-05-06 Thread Nick Veitch
Blueprint changed by Nick Veitch:

Work items changed:
  Work items for ubuntu-13.04-month-6:
  [evilnick] Define structural elements of HTML5 doc: DONE
- [evilnick] Create sample getting Started Guide: TODO
+ [evilnick] Create sample getting Started Guide: DONE
  [evilnick] Create list of screencasts: TODO
  [jorge] Develop screen casts based on defined list: TODO

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-04-25 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Name: servercloud-1303-juju-docs = servercloud-s-juju-docs

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-04-25 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Priority: Undefined = High

-- 
Improve Juju Documentation
https://blueprints.launchpad.net/ubuntu/+spec/servercloud-s-juju-docs

-- 
Ubuntu-server-bugs mailing list
Ubuntu-server-bugs@lists.ubuntu.com
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/ubuntu-server-bugs


[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-04-25 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using 

[Blueprint servercloud-s-juju-docs] Improve Juju Documentation

2013-04-25 Thread Antonio Rosales
Blueprint changed by Antonio Rosales:

Whiteboard changed:
  --- UDS 1303 Discussion ---
  PAD URL:  http://pad.ubuntu.com/uds-1303-servercloud-1303-juju-docs
    -Leave behind RST!
    -pandoc doesn't support some of the newer HTML5 elements (asides, etc)
    HTML5 w/ JavaScript it is!
    -Make sure juju.ubuntu.com landing page tell Juju story well (what is it, 
why should I use it)
    -Dynamic Content
  -Screencasts
  -Code Examples
  -Better references in sidbars with improved navigation
  -Annotate Juju deploy command
  -Annootate Juju GUI deploy
  -Annotate anatomoy of a charm
  
  --- Ideas ---
  Good examples:
   *stripe.com (https://stripe.com/docs)
     -good journeys
     -not overwhelming
   *http://developer.android.com/sdk/index.html
     -ttp://developer.android.com/tools/workflow/index.html
  
  Would like to have good sidebar notes, screen shots, tips, and examples.
  
  Would like to have knowledge of what I am at in a journey
    *Getting Started (Juju deploy)
    *Charm Development
    *Charm Deployment
    *Charm Discovery
    *Charm Debugging
  
  Model magazines
    *Wired
    *Linux Format
    *Content rich
  
  Need version control
  Want Markdown not RST
  Get rid of anything marked draft
  Need organization of what we currently have.
  Evaluate Pandoc instead of Sphinx
  Discuss GUI and Charm Browser
  
  --- Immediate Needs ---
  Verify the usability of docs (are the instructions correct).
  Identify a model for the docs (framework)
    *Not docbook - too complicated and print-biased
    *Sphinx? Needed since core is now Go?
    *Something markdown based?
    *simple HTML5?
  Milestone
    *13.04 default for Go
    *How to use it
    *Transition
  -Differences
  -Py and Go living together
  
  --- Organization ---
  
  juju users:
  Getting started
     Local provider configuration
     OpenStack provider configuration
     EC2 provider configuration
     Rackspace
     New Providers
     Deploying a Charm
     Exposing A charm
     Implicit Relations
     Machine Constraints
   * User tutorial - rename to “Using Juju” (should be embeddedd per topic)
  Charms
  The Juju Charm Store (for users)
  Handling common errors
  
  charm authors:
  Writing a charm
  The Juju Charm Store
  Charm Testing
  Hook debugging
  Charm Store Policy
  Charm Quality Rating
  Debugging
  
  Reference Guide
    Full table of all charm attributes
    Full table of all juju commands
    example: http://developer.android.com/reference/packages.html
    Glossary -appendix
    Operating Systems - appendix stuff
    Relation references - appendix stuff
  
  Evaluate for removal:
  -move-
   About juju - *move to juju.ubuntu.com.
  -delete-
  Frequently Asked Questions - DELETE THIS, link to autogenerated FAQ at AU.
  juju modules - remove Juju core specific
  Drafts - REMOVE.
  -content should be covered-
  Implementation details - (should be in reference guide for charm 
attributes)
  Commands to work with relation settings and membership (be sure to cover 
in charm author)
  Upgrades - both (be sure how to implement charm upgrade hooks are covered 
in charm author)
  Charm Upgrades (be sure to be covered in Charm Users: deployment)
  New relation-ids hook command -(should be covered in charm author)
  
  # Documentation Framework (Courseware)
  
  https://juju.ubuntu.com/docs/charm.html
  -Make sure to review the docs point, and have a corrolation betweeen user 
jouneys and screen casts.
  - Put screen cast in docs
  -screen casets and docs should reference each other.
  
  0 -- New to Juju
  1. [user] Installing and configurating Juju
   i. https://juju.ubuntu.com/docs/getting-started.html
   1. Charm Introduction
     i. https://juju.ubuntu.com/docs/charm.html
  1. Charm Discovery/ Charm Store
    i https://juju.ubuntu.com/docs/charm-store.html
  1. [user] Deploying your first charm (include constraints)
   i. https://juju.ubuntu.com/docs/user-tutorial.html
  
  1. [user] How to use relations
  creating relations
  removing relations
  1. [user] Service configuration/Lifecycle managment: Using the 
configuration.yaml  juju set
    i. https://juju.ubuntu.com/docs/service-config.html
  
  1.[user] Scaling services
  1. [user] Debugging deployment - debug logs and friends
  1. [user] Advanced topics (deploy-to, jitsu and friends)
    -need to confirm how plug-in model is in Juju 2.0
  
  1- New Charm Author
  Review https://juju.ubuntu.com/docs/write-charm.html
  
  1. Submitting your first contribution to a charm
  1. Writing a new charm from scratch.
    i. https://juju.ubuntu.com/docs/write-charm.html
    a. charm tools
    a. meta-data/readme/licensing/examples/description/how to use/why to use 
from Ops or Dev perspective
    a. Hooks
    a. relations
   i. interface
   i. requires
    a. testing
  1. Publishing to the Juju Charm Store
  1. How to improve your charm using