<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Mon, Jul 28, 2014 at 4:24 PM, Jorge Williams <span dir="ltr"><<a href="mailto:jorge.williams@rackspace.com" target="_blank">jorge.williams@rackspace.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">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.<br>
<br></blockquote><div><br></div><div>I've talked about that before with David Cramer when working through a content sharing blueprint. We have a blueprint [1] [2] we worked on. I recently marked it Obsolete for a few reasons:</div>
<div>- We have a reliable HTTP URI from <a href="http://git.openstack.org">git.openstack.org</a> (we don't rely on github)<br></div><div>- We haven't had a lot of multiple-collaboration scenarios on API docs (Diane has been our go-to for a long time [3])</div>
<div>- We aren't seeing much upstream contribution work from cloud providers on API docs</div><div><br></div><div>So I'd prefer we don't try to engineer this solution. Really I'd prefer that we stop building and publishing documents from the <servicename>-api repos for a couple of reasons:</div>
<div>- We had agreement two summits ago to stop storing those sources in separate repos</div><div>- There's a serious bug with the <servicename>-api output where it doesn't show all the parameters for each call. [4]</div>
<div><br></div><div>With all the difficulty we're seeing, I think this is a symptom of a wider problem and we should try to find a simpler way to maintain API docs. Any other thoughts?</div><div><br></div><div>Anne</div>
<div><br></div><div>1. <a href="https://wiki.openstack.org/wiki/Documentation/ContentSharing">https://wiki.openstack.org/wiki/Documentation/ContentSharing</a></div><div>2. <a href="https://blueprints.launchpad.net/openstack-manuals/+spec/design-content-sharing">https://blueprints.launchpad.net/openstack-manuals/+spec/design-content-sharing</a></div>
<div>3. <a href="http://stackalytics.com/?release=icehouse&project_type=documentation&module=api-site&metric=commits">http://stackalytics.com/?release=icehouse&project_type=documentation&module=api-site&metric=commits</a></div>
<div>4. <a href="https://bugs.launchpad.net/openstack-manuals/+bug/1342379">https://bugs.launchpad.net/openstack-manuals/+bug/1342379</a> and <a href="https://bugs.launchpad.net/openstack-api-site/+bug/1300249">https://bugs.launchpad.net/openstack-api-site/+bug/1300249</a></div>
<div><br></div><div> </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
-jOrGe W.<br>
<div class=""><div class="h5"><br>
<br>
<br>
<br>
On Jul 28, 2014, at 3:01 PM, Andreas Jaeger <<a href="mailto:aj@suse.com">aj@suse.com</a>> wrote:<br>
<br>
> On 07/28/2014 09:49 PM, Christian Berendt wrote:<br>
>> On 07/28/2014 09:46 PM, Anne Gentle wrote:<br>
>>> We already do test and gate on something building, but the problem was<br>
>>> with two repos, so I think is that he "race condition" problem we see in<br>
>>> other cross-repo dependencies?<br>
>><br>
>> I mean the cross-repo dependencies. Is it not possible to build checks<br>
>> to check if identity-api still builds when changing something in api-site?<br>
><br>
> Since we're not providing a "binary" that can be used in the environment<br>
> but instead download directly from the other git repository, I do not<br>
> see how to implement this.<br>
><br>
> Also, how are we getting in a change that renames a file in one<br>
> repository and the change for that in the other one together?<br>
><br>
> So, as much as I would like to see such gating done for these few repos,<br>
> I have no clever idea. If you have one, please write up a blueprint,<br>
><br>
> Andreas<br>
> --<br>
> Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter/Identica: jaegerandi<br>
> SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
> GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)<br>
> GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126<br>
><br>
</div></div><div class=""><div class="h5">> _______________________________________________<br>
> Openstack-docs mailing list<br>
> <a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a><br>
> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br>
</div></div></blockquote></div><br></div></div>