Open Stack

On Tue, Nov 26, 2013 at 3:39 PM, Andreas Jaeger <aj at suse.com> wrote:

> On 11/26/2013 09:07 PM, Anne Gentle wrote:
> >
> >
> >
> > On Tue, Nov 26, 2013 at 1:57 PM, Andreas Jaeger <aj at suse.com
> > <mailto:aj at suse.com>> wrote:
> >
> >     On 11/26/2013 08:31 PM, Andreas Jaeger wrote:
> >     > I read that you discussed at the summit a docutils repo and I'd
> >     like to
> >     > work on implementing all the bits for it - if nobody else has
> >     > volunteered yet for it.
> >     >
> >     > Did you discuss any further things on how to use it? Before I
> write up
> >     > my own ideas, I'd like to read what you already discussed.
> >     >
> >     > Btw. how can I request a new git repo? I would start this while we
> >     still
> >     > discuss the specifics...
> >
> >
> >     Referenced in:
> >     https://etherpad.openstack.org/p/icehouse-doc-translation
> >     starting line 67
> >
> >
> > Yes, there it is.
> >
> > I think that you just request the repo from the Infrastructure team.
> > There's still some research in the options listed there, and some of
> > which I'm not informed enough to be opinionated about. The main ideas
> > and goals are about translation, autodoc generation, and validation.
>
> I've asked #openstack-infra for help and got pointers on how to request
> a new repo - and since fungi was confused by "docutils" I took the
> proposal from the etherpad and proposed "doctools". The patch is at:
> https://review.openstack.org/#/c/58623/
>
> I created an initial repository consisting of all the content from the
> tools subdirectory of openstack-manuals and pushed it to
> https://github.com/ajaeger/doctools. Do you think that's the proper
> initial layout and content? Or should I remove some more files?
>
>
> For building documentation (like openstack-manuals) with Jenkins, I see
> two options:
> Option 1: Have Jenkins checkout the doctools repository every time and
>           use that for building - similar to the "devstack-checkout"
>           job
>
> Option 2: Copy the tools and all support files to each and every
> repository. We could automate that.
>
> I suggest to investigate whether option 1 is feasible and go for that.
> It gives us the benefit that any change to doctools will immediately be
> reflected in any other repo - and that's a problem as well ;)
>
> Moving forward, I'd like to have all our repositories (api-site,
> compute-api, identity-api, image-api, netconn-api, object-api,
> volume-api, operations-guide, openstack-manuals) use proper gates,
> thus extend "test.py" so that it can be used in more places.
> Right now only operations-guide and openstack-manuals are gated - but
> operations-guide uses an old version of the tools.
>
>
One comment about <service>-api repos -- those are going to be deleted in
the icehouse release with the content moved to <project>/doc/source
repositories. Can you envision gating on those specific directories?

Thanks,
Anne


> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20131126/f2337b0a/attachment-0001.html>