cloudstack-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dag Sonstebo <Dag.Sonst...@shapeblue.com>
Subject CloudStack documentation - comments
Date Thu, 19 May 2016 11:00:48 GMT
All,

(This is a cross post from the developers list.)

since we've added CloudStack documentation to the discussion topics for the Montreal meetup
I wanted to gauge peoples opinion on areas of improvement.

Personally I would like to see the following:

  1.  Overall documentation navigation needs to be improved.
  2.  Ideally all documentation should be under a single documentation tree with a single
table of contents. All content should be searchable without having to visit each of the current
documentation roots separately (Getting Started / Installation Guide / Admin Guide / Release
Notes).
  3.  Advanced topics should be moved away from the "Getting Started Docs". The people reading
the getting started / concepts sections are typically new CloudStack users  who will easily
be put off by immediately being presented with advanced topics.
  4.  API documentation to be a chapter of the Developers guide.
  5.  Upgrade instructions to be moved from the release notes to the installation guide.
  6.  Compatibility matrix in single location only – i.e. not in both the release notes
and installation guide as this has caused discrepancies in the past.

Any other comments or suggestions from the user community is appreciated.

Regards,

Dag.Sonstebo@shapeblue.com 
www.shapeblue.com
53 Chandos Place, Covent Garden, London  WC2N 4HSUK
@shapeblue


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message