<div dir="ltr">Hi all, <div>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. </div>
<div><br></div><div>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:</div>
<div>/api</div><div>/training</div><div>/user</div><div>/appdev</div><div>juno/ops (this is where install and config specs would live)</div><div>/security</div><div><br></div><div>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:</div>
<div><br></div><div>------------------------------------start template------------------------------------<br></div><div><div>..</div><div> This work is licensed under a Creative Commons Attribution 3.0 Unported</div><div>
License.</div><div><br></div><div> <a href="http://creativecommons.org/licenses/by/3.0/legalcode">http://creativecommons.org/licenses/by/3.0/legalcode</a></div><div><br></div><div>==========================================</div>
<div>Example Spec - The title of your blueprint</div><div>==========================================</div><div><br></div><div>Include the URL of your launchpad blueprint:</div><div><br></div><div><a href="https://blueprints.launchpad.net/openstack-manuals/+spec/example">https://blueprints.launchpad.net/openstack-manuals/+spec/example</a></div>
<div><br></div><div>Introduction paragraph -- why are we doing anything? A single paragraph of</div><div>prose that operators can understand.</div><div><br></div><div>Some notes about using this template:</div><div><br></div>
<div>* Your spec should be in ReSTructured text, like this template.</div><div><br></div><div>* Please wrap text at 79 columns.</div><div><br></div><div>* The filename in the git repository should match the launchpad URL, for</div>
<div> example a URL of: <a href="https://blueprints.launchpad.net/openstack-manuals/+spec/awesome-doc">https://blueprints.launchpad.net/openstack-manuals/+spec/awesome-doc</a></div><div> should be named awesome-doc.rst</div>
<div><br></div><div>* Please do not delete any of the sections in this template. If you have</div><div> nothing to say for a whole section, just write: None</div><div><br></div><div>* For help with syntax, see <a href="http://sphinx-doc.org/rest.html">http://sphinx-doc.org/rest.html</a></div>
<div><br></div><div>* To test out your formatting, build the docs using tox, or see:</div><div> <a href="http://rst.ninjs.org">http://rst.ninjs.org</a></div><div><br></div><div>* If you would like to provide a diagram with your spec, ascii diagrams are</div>
<div> required. <a href="http://asciiflow.com/">http://asciiflow.com/</a> is a very nice tool to assist with making</div><div> ascii diagrams. The reason for this is that the tool used to review specs is</div><div> based purely on plain text. Plain text will allow review to proceed without</div>
<div> having to look at additional files which can not be viewed in gerrit. It</div><div> will also allow inline feedback on the diagram itself.</div><div><br></div><div><br></div><div>Problem description</div><div>===================</div>
<div><br></div><div>A detailed description of the problem:</div><div><br></div><div>* For a new document, ensure you are clear about the</div><div> audience: End User vs Deployer</div><div><br></div><div>* For a major reworking of something existing it would describe the</div>
<div> problems in that document that are being addressed.</div><div><br></div><div><br></div><div>Proposed change</div><div>===============</div><div><br></div><div>Here is where you cover the change you propose to make in detail. How do you</div>
<div>propose to solve this problem?</div><div><br></div><div>If this is one part of a larger effort make it clear where this piece ends. In</div><div>other words, what's the scope of this effort?</div><div><br></div>
<div>
Alternatives</div><div>------------</div><div><br></div><div>What other ways could we do this document? Why aren't we using those? This doesn't</div><div>have to be a full literature review, but it should demonstrate that thought has</div>
<div>been put into why the proposed solution is an appropriate one.</div></div><div><br></div><div><div>Implementation</div><div>==============</div><div><br></div><div>Assignee(s)</div><div>-----------</div><div><br></div>
<div>Who is leading the writing of the code? Or is this a blueprint where you're</div><div>throwing it out there to see who picks it up?</div><div><br></div><div>If more than one person is working on the implementation, please designate the</div>
<div>primary author and contact.</div><div><br></div><div>Primary assignee:</div><div> <launchpad-id or None></div><div><br></div><div>Other contributors:</div><div> <launchpad-id or None></div><div><br></div>
<div>Work Items</div><div>----------</div><div><br></div><div>Work items or tasks -- break the feature up into the things that need to be</div><div>done to implement it. Those parts might end up being done by different people,</div>
<div>but we're mostly trying to understand the timeline for implementation.</div><div><br></div><div><br></div><div>Dependencies</div><div>============</div><div><br></div><div>* Include specific references to specs and/or blueprints in glance, or in other</div>
<div> projects, that this one either depends on or is related to.</div><div><br></div><div>* If this requires functionality of another project that is not currently used</div><div> by Glance: document that fact.</div><div>
<br></div><div>* Does this feature require any new library dependencies or code otherwise not</div><div> included in OpenStack? Or does it depend on a specific version of library?</div><div><br></div><div><br></div><div>
Testing</div><div>=======</div><div><br></div><div>Please discuss how the changed document will be tested. </div></div><div><br></div><div><div>References</div><div>==========</div><div><br></div><div>Please add any useful references here. You are not required to have any</div>
<div>reference. Moreover, this specification should still make sense when your</div><div>references are unavailable. Examples of what you could include are:</div><div><br></div><div>* Links to mailing list or IRC discussions</div>
<div><br></div><div>* Links to notes from a summit session</div><div><br></div><div>* Links to relevant research, if appropriate</div><div><br></div><div>* Related specifications as appropriate (e.g., if it's an EC2 thing, link the</div>
<div> EC2 docs)</div><div><br></div><div>* Anything else you feel it is worthwhile to refer to</div></div><div>------------------------------------end template------------------------------------</div><div><br></div><div>
<br class="">What do you think about this approach? <br></div><div>Thanks,</div><div>Anne</div></div>