<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body ><div>Couldn't we build something like the following into our builds to ensure links are okay? </div><div><br></div><div>http://wummel.github.io/linkchecker/</div><div><br></div><div><br></div><div><div style="font-size:13px;color:#575757">Sent from my Verizon Wireless 4G LTE smartphone</div></div><div></div><br><br>-------- Original message --------<br>From: Anne Gentle <anne@openstack.org> <br>Date:08/03/2014 10:48 AM (GMT-06:00) <br>To: Andreas Jaeger <aj@suse.com> <br>Cc: dfleming@austin.rr.com, openstack-docs@lists.openstack.org <br>Subject: Re: [Openstack-docs] identity-api: Building broken <br><br><div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Sat, Aug 2, 2014 at 1:20 PM, Andreas Jaeger <span dir="ltr"><<a href="mailto:aj@suse.com" target="_blank">aj@suse.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"><div class="">On 08/02/2014 05:25 AM, Anne Gentle wrote:<br>
><br>
><br>
> On Tue, Jul 29, 2014 at 11:51 AM, <<a href="mailto:dfleming@austin.rr.com">dfleming@austin.rr.com</a><br>
</div><div class="">> <mailto:<a href="mailto:dfleming@austin.rr.com">dfleming@austin.rr.com</a>>> wrote:<br>
><br>
> Also, if we move that content to the api-site/api-ref-guides<br>
> directory, the guides would point directly to the WADLs in<br>
> api-site/api-ref directory, so they pick up current content rather<br>
> than pointing to what's merged into master by way of URL.<br>
><br>
><br>
> Hi all,<br>
> Diane had a great idea over breakfast about how to mitigate these<br>
> issues, and I've put together a pair of patches that put the solution in<br>
> place to see what others think.<br>
><br>
> The idea is to stop embedding WADL references in the Dev References and<br>
> instead link to the HTML output. Any relevant info for a particular call<br>
> moves into the WADL itself.<br>
><br>
> I think this solves many of the issues I listed previously, so please<br>
> review this approach and let us know what you think on the review (or<br>
> here on the mailing list thread).<br>
<br>
</div>There's still a tight coupling between these - whenever an URL in the<br>
api-site changes, we might need to adjust compute-api. Is there no way<br>
to avoid this duplication completely?<br></blockquote><div><br></div><div>I agree, it's better to avoid the duplication, but this can be an interim step to get time to write the "all OpenStack API" guide that would consolidate all of the <project>-api repos for end-users and move the "specs" into <project> repos.</div>
<div><br></div><div>We have this as Goal #4 here: <a href="https://wiki.openstack.org/w/index.php?title=Blueprint-os-api-docs#Goal_4_-_Move_API_Specs_to_project_repositories_and_off_docs_landing_page">https://wiki.openstack.org/w/index.php?title=Blueprint-os-api-docs#Goal_4_-_Move_API_Specs_to_project_repositories_and_off_docs_landing_page</a></div>
<div><br></div><div>The blueprint got marked implemented even though that step isn't complete.</div><div><br></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">
<br>
The one nice thing with WADLs is that if the link is wrong, you get a<br>
build time error - with this change, it's a silent failure.<br>
<br>
I do like the idea but the above concerns me. Thanks for looking into this!<br>
<div class="im"><br>
> These examples are for Compute API v2, I'd do the same for Identity API<br>
> docs and others with embedded WADL in the Dev Ref.<br>
><br>
> <a href="https://review.openstack.org/111436" target="_blank">https://review.openstack.org/111436</a><br>
><br>
> <a href="https://review.openstack.org/#/c/111435/" target="_blank">https://review.openstack.org/#/c/111435/</a><br>
<br>
</div><div class=""><div class="h5">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>
</div></div></blockquote></div><br></div></div>
</body></html>