Hello again - In yesterday's team meeting, Brian Lamar brought up a good point - why name the API projects after the project name, why not the product name? This makes a lot of sense to me. So the names for the API repos will be:
compute-api identity-api (should this be auth-api?) image-api storage-api (should this be object-api?) Let me know your feedback on this naming standard. Thanks Jay for catching the keystone-api typo. :) Anne *Anne Gentle* [email protected] my blog <http://justwriteclick.com/> | my book<http://xmlpress.net/publications/conversation-community/>| LinkedIn <http://www.linkedin.com/in/annegentle> | Delicious<http://del.icio.us/annegentle>| Twitter <http://twitter.com/annegentle> On Tue, Sep 6, 2011 at 1:02 PM, Anne Gentle <[email protected]> wrote: > Hi all - > > I wanted to discuss some changes to the API documentation for each project > prior to implementation to make sure I'm not missing any crucial detail and > to ensure you all feel you have ownership of the solution and input into it. > My goal is to move all the OpenStack documentation into github repos. In > doing so, I will also move all the API documentation into separate repos > with a goal of completing the move by October 1st. > > Here is my current proposal, please feel free to suggest corrections as you > see fit. > > 1. Create new github repos named <project>-api that contain: > API documentation including existing API Dev Guides and in the case of > Nova, an API Spec. Four new projects for now: openstack/glance-api, > openstack/keystone, openstack/nova-api, openstack/swift-api. > > 2. Create connection to Gerrit for review by core devs for each project, > plus the creation of a new group, openstack-core-doc, for reviews of all > four projects. > > 3. Create a new github repo named openstack/openstack-manuals to contain > sys admin documentation such as the Admin manuals (installation, > configuration, administration docs). > > 4. Automated build/publish on Jenkins to the correct location on > docs.openstack.org (or project.openstack.org as appropriate), either > /diablo or /api or /incubation depending on project's state. Also includes > Jenkins jobs to validate the docs pre-merge, for XML validation and testing > for missing figures. > > Please give me your feedback by the end of this week so we can make the > next moves. Ha! Move! I've also added this item for discussion at today's > team meeting. > > Thanks, > Anne > >
_______________________________________________ Mailing list: https://launchpad.net/~openstack Post to : [email protected] Unsubscribe : https://launchpad.net/~openstack More help : https://help.launchpad.net/ListHelp
