[openstack-dev] [Doc] place to add API reference

Anne Gentle annegentle at justwriteclick.com
Fri Apr 15 17:45:14 UTC 2016


On Fri, Apr 15, 2016 at 12:04 PM, Sean McGinnis <sean.mcginnis at gmx.com>
wrote:

> On Fri, Apr 15, 2016 at 11:17:40AM -0500, Anne Gentle wrote:
> > Sean and I are collaborating on a cross project spec to talk about at
> the Summit. Can you talk about concerns or cons to this approach so we can
> put it in the spec?
> >
> > Thanks,
> > Anne
>
> Thanks Anne. No concerns at the moment. I was just afraid I had missed
> something from the discussions.
>

Okay, good. My sense is that this project ownership of API docs is a great
direction.


>
> Thanks for the clarification. I will watch for the cross project
> session.
>

Here's the one you want.

https://www.openstack.org/summit/austin-2016/summit-schedule/events/9479

Thanks -
Anne


>
> Thanks!
> Sean
>
> >
> >
> > > On Apr 15, 2016, at 11:02 AM, Sean McGinnis <sean.mcginnis at gmx.com>
> wrote:
> > >
> > >> On Fri, Apr 15, 2016 at 09:38:20AM +0200, Andreas Jaeger wrote:
> > >>> On 04/15/2016 08:14 AM, Masahito MUROI wrote:
> > >>> Hi Doc team folks,
> > >>>
> > >>> Congress team plans to add API reference into [1] instead of [2] to
> > >>> follow official documentation project. But I found the design session
> > >>> about a API docs style[3].
> > >>>
> > >>> For now, is it ok to add API reference [1], or should we wait the
> > >>> decision about style of API reference repository?
> > >>>
> > >>> 1. http://developer.openstack.org/api-ref.html
> > >>> 2. http://docs.openstack.org/developer/congress/
> > >>> 3.
> > >>>
> https://www.openstack.org/summit/austin-2016/summit-schedule/events/9479?goback=1
> > >>
> > >>
> > >> See the work that is done by Sean Dague and Anne Gentle for nova and
> > >> follow this setup:
> > >>
> http://lists.openstack.org/pipermail/openstack-dev/2016-April/092234.html
> > >
> > > I thought I followed all of the emails on moving to Swagger then RST.
> > > Moving the api docs in tree with the projects is something I wasn't
> > > aware of.
> > >
> > > Was there a cross-project spec for this or something detailing the long
> > > term goal and direction each team should take for doing this? I see the
> > > work Nova has done (looks great) but is that something that team has
> > > decided to explore or is this something all of us should be involved
> in?
> > >
> > > Sorry, just caught a little off guard here and trying to figure out
> what
> > > I've missed.
> > >
> > > Sean
> > >
> > >>
> > >> There have been a couple more emails in the last months on this topic
> > >>
> > >> Also, there's a spec:
> > >>
> http://specs.openstack.org/openstack/docs-specs/specs/mitaka/app-guides-mitaka-vision.html
> > >>
> > >> so, you should do this in your own repository, set up proper jobs -
> > >> and then publish to developer.openstack.org
> > >
> > > That spec doesn't say anything about moving to each project's
> > > repository. Is there something else with more detail?
> > >
> > >>
> > >> Andreas
> > >> --
> > >> Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica:
> jaegerandi
> > >>  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
> > >>   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
> > >>       HRB 21284 (AG Nürnberg)
> > >>    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272
> A126
> > >>
> > >>
> > >>
> __________________________________________________________________________
> > >> OpenStack Development Mailing List (not for usage questions)
> > >> Unsubscribe:
> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> > >> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> > >
> > >
> __________________________________________________________________________
> > > OpenStack Development Mailing List (not for usage questions)
> > > Unsubscribe:
> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> > > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> >
> >
> __________________________________________________________________________
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe:
> OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>



-- 
Anne Gentle
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20160415/04674c48/attachment.html>


More information about the OpenStack-dev mailing list