Documentation review and clean up

Registered by Julian Edwards on 2013-10-09

Discuss documentation pain points and missing parts

Blueprint information

Status:
Not started
Approver:
Daniel Westervelt
Priority:
Undefined
Drafter:
None
Direction:
Approved
Assignee:
None
Definition:
New
Series goal:
None
Implementation:
Informational Informational
Milestone target:
None

Related branches

Sprints

Whiteboard

Documentation review and clean up

Small/medium fixes:
* API objects needs to be documented (bug 1242900)
* Improve the CSS (!!) -evilnick
* Fix the home page (which is just a list, similar to what's displayed on the side)- evilnick
* Preseed documentation - how they work and how to modify.
* Go through each and every page and make sure it's up to date (tags example for juju is wrong (https://bugs.launchpad.net/maas/+bug/1240418))

Missing pages:
 * Documented scenarios describing some typical setups:
   - using existing DHCP server + local machines
   - using a script creating machines inside KVM
 * warn about existing DHCP server on network and don't run MAAS one if so
 * Documentation is too vague for newcomers - jargon, undefined terms, assumptions around DHCP/DNS
 * DHCP configuration is a pain point - using existing one or setting up MAAS one
 * How does average user test maas with no hardware (using virtual machines)

https://bugs.launchpad.net/maas/+bug/1228377

Maarten Ectors' first impressions:
  https://docs.google.com/a/canonical.com/document/d/1X-xSbmGBo-GoHIvMdG-XiySivSI0oi7HBvQ7OtJUgB8/edit

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.