Open Stack

On Tue, Jul 29, 2014 at 11:51 AM, <dfleming at austin.rr.com> wrote:

> Also, if we move that content to the api-site/api-ref-guides directory,
> the guides would point directly to the WADLs in api-site/api-ref directory,
> so they pick up current content rather than pointing to what's merged into
> master by way of URL.
>
>
Hi all,
Diane had a great idea over breakfast about how to mitigate these issues,
and I've put together a pair of patches that put the solution in place to
see what others think.

The idea is to stop embedding WADL references in the Dev References and
instead link to the HTML output. Any relevant info for a particular call
moves into the WADL itself.

I think this solves many of the issues I listed previously, so please
review this approach and let us know what you think on the review (or here
on the mailing list thread).

These examples are for Compute API v2, I'd do the same for Identity API
docs and others with embedded WADL in the Dev Ref.

https://review.openstack.org/111436

https://review.openstack.org/#/c/111435/
Thanks,
Anne



>
> ---- dfleming <dfleming at austin.rr.com> wrote:
> > Perhaps we could move the development guides out of their own
> repositories and put them all in the api - site repo and build everything
> there. That way, we know immediately whether the build breaks.  We could
> put them in api-site/api - ref - guides directory.
>
>
> Sent from my Verizon Wireless 4G LTE smartphone
>
>
> -------- Original message --------
> From: Jorge Williams <jorge.williams at rackspace.com>
> Date:07/28/2014  4:24 PM  (GMT-06:00)
> To: Andreas Jaeger <aj at suse.com>
> Cc: openstack-docs at lists.openstack.org
> Subject: Re: [Openstack-docs] identity-api: Building broken
>
> Maybe we need to rethink our model.  Rather than reaching directly to a
> HTTP URI in github, we can instead list the WADL as a dependency in maven.
>  Should be possible, we can tar up the api-ref project, have a deployment
> that stores it somewhere — maybe maven central…then when we build our docs
> we download and extract the correct version and tie everything together.
>
> -jOrGe W.
>
>
>
>
> On Jul 28, 2014, at 3:01 PM, Andreas Jaeger <aj at suse.com> wrote:
>
> > On 07/28/2014 09:49 PM, Christian Berendt wrote:
> >> On 07/28/2014 09:46 PM, Anne Gentle wrote:
> >>> We already do test and gate on something building, but the problem was
> >>> with two repos, so I think is that he "race condition" problem we see
> in
> >>> other cross-repo dependencies?
> >>
> >> I mean the cross-repo dependencies. Is it not possible to build checks
> >> to check if identity-api still builds when changing something in
> api-site?
> >
> > Since we're not providing a "binary" that can be used in the environment
> > but instead download directly from the other git repository, I do not
> > see how to implement this.
> >
> > Also, how are we getting in a change that renames a file in one
> > repository and the change for that in the other one together?
> >
> > So, as much as I would like to see such gating done for these few repos,
> > I have no clever idea. If you have one, please write up a blueprint,
> >
> > 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
> >
> > _______________________________________________
> > Openstack-docs mailing list
> > Openstack-docs at lists.openstack.org
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140801/1d69c19c/attachment-0001.html>