Open Stack

Hi all,
I wanted to hear more from the teams about a need for a doc-specs repo. The
training team has started to bring specs into their repo. I'm happy to get
this started for the Documentation program but wanted to get some input.

I'd like to have an openstack/doc-spec repo set up with different
directories for each area of the documentation. Some projects have
designated by release as well, though since only our install guide and
config guides are "released" I think we could just have:
/api
/training
/user
/appdev
juno/ops (this is where install and config specs would live)
/security

Also, I don't think the developer template is useful to us. I'd like to
have a template that is document centric. Here's a proposal:

------------------------------------start
template------------------------------------
..
 This work is licensed under a Creative Commons Attribution 3.0 Unported
 License.

 http://creativecommons.org/licenses/by/3.0/legalcode

==========================================
Example Spec - The title of your blueprint
==========================================

Include the URL of your launchpad blueprint:

https://blueprints.launchpad.net/openstack-manuals/+spec/example

Introduction paragraph -- why are we doing anything? A single paragraph of
prose that operators can understand.

Some notes about using this template:

* Your spec should be in ReSTructured text, like this template.

* Please wrap text at 79 columns.

* The filename in the git repository should match the launchpad URL, for
  example a URL of:
https://blueprints.launchpad.net/openstack-manuals/+spec/awesome-doc
  should be named awesome-doc.rst

* Please do not delete any of the sections in this template.  If you have
  nothing to say for a whole section, just write: None

* For help with syntax, see http://sphinx-doc.org/rest.html

* To test out your formatting, build the docs using tox, or see:
  http://rst.ninjs.org

* If you would like to provide a diagram with your spec, ascii diagrams are
  required.  http://asciiflow.com/ is a very nice tool to assist with making
  ascii diagrams.  The reason for this is that the tool used to review
specs is
  based purely on plain text.  Plain text will allow review to proceed
without
  having to look at additional files which can not be viewed in gerrit.  It
  will also allow inline feedback on the diagram itself.


Problem description
===================

A detailed description of the problem:

* For a new document, ensure you are clear about the
  audience: End User vs Deployer

* For a major reworking of something existing it would describe the
  problems in that document that are being addressed.


Proposed change
===============

Here is where you cover the change you propose to make in detail. How do you
propose to solve this problem?

If this is one part of a larger effort make it clear where this piece ends.
In
other words, what's the scope of this effort?

Alternatives
------------

What other ways could we do this document? Why aren't we using those? This
doesn't
have to be a full literature review, but it should demonstrate that thought
has
been put into why the proposed solution is an appropriate one.

Implementation
==============

Assignee(s)
-----------

Who is leading the writing of the code? Or is this a blueprint where you're
throwing it out there to see who picks it up?

If more than one person is working on the implementation, please designate
the
primary author and contact.

Primary assignee:
  <launchpad-id or None>

Other contributors:
  <launchpad-id or None>

Work Items
----------

Work items or tasks -- break the feature up into the things that need to be
done to implement it. Those parts might end up being done by different
people,
but we're mostly trying to understand the timeline for implementation.


Dependencies
============

* Include specific references to specs and/or blueprints in glance, or in
other
  projects, that this one either depends on or is related to.

* If this requires functionality of another project that is not currently
used
  by Glance: document that fact.

* Does this feature require any new library dependencies or code otherwise
not
  included in OpenStack? Or does it depend on a specific version of library?


Testing
=======

Please discuss how the changed document will be tested.

References
==========

Please add any useful references here. You are not required to have any
reference. Moreover, this specification should still make sense when your
references are unavailable. Examples of what you could include are:

* Links to mailing list or IRC discussions

* Links to notes from a summit session

* Links to relevant research, if appropriate

* Related specifications as appropriate (e.g., if it's an EC2 thing, link
the
  EC2 docs)

* Anything else you feel it is worthwhile to refer to
------------------------------------end
template------------------------------------


What do you think about this approach?
Thanks,
Anne
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140625/1d57ed36/attachment.html>