Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Re-think our documentation tree
    • Maybe merge all guides in one
  • Correct the docs
    • There are still lots of issues that came from the old docs
  • Create a new theme for it.
    • 4/6/2015 PL Dion working on something there.
  • Close all old JIRA tickets that relate to old docs
    • Maybe during JIRAthon
  • Review and improve the API Reference documentation http://cloudstack.apache.org/docs/api/ )
    • Issues to cover (suggested by Phillip Kent): 
      • parameters being required but are not marked as required (and probably there are cases of vice versa); 
      • have a better format for marking parameters that are conditionally required;
      • fix inaccurate command description texts; 
      • general problem of description text being too brief to properly explain the action of the command and how to use the parameters;
      • ? add another field for long description, examples? Or, is that better covered in the main documentation set and/or 'Publish playbooks/recipes to deploy workloads on CloudStack' above?
  • Delete wiki pages that relate to old docs
  • ? Is there an issue for maintaining improved documentation sets for multiple ACS versions = something analogous to the backporting efforts on the source code?
  • Make sure google indexes the new docs and has not kept the old ones
  • Remove the old docs from the svn website repo
  • Routinely build the multi-language support from transifex translation
  • If we find a sponsor we might be able to get O'Reilly to publish a CloudStack cookbook.
    • 4/6/2015 S. Goasguen to ask O'Reilly about feasibility.

...