Open Stack

On Fri, Jul 19, 2013 at 3:50 PM, Lorin Hochstein
<lorin at nimbisservices.com>wrote:

> My personal opinion is that it's OK to use them as long as you try to
> build the doc yourself to verify that nothing is broken. Reviewers should
> also verify that docs build until we get the proper gating in place.
>
>
Yep, this. Thanks Lorin!


> Lorin
>
>
>
> On Fri, Jul 19, 2013 at 4:39 PM, Nermina Miller <nerminamiller at gmail.com>wrote:
>
>> Thanks, Lorin! Is it better not to use the links until support is
>> available? - n
>>
>>
>> On Friday, July 19, 2013, Lorin Hochstein wrote:
>>
>>> Nermina:
>>>
>>> It's not you, it's us. ;)
>>>
>>> We currently do not have a gate check to verify links are valid. We're
>>> working on having the gate check do full doc builds so that that Gerrit
>>> won't allow people to commit changes that can break the docs.
>>>
>>> I believe linkend is the correct way to do cross-referencing right now,
>>> and olink support is in the works for the future.
>>>
>>> Take care,
>>>
>>> Lorin
>>>
>>>
>>> On Fri, Jul 19, 2013 at 4:31 PM, Nermina Miller <nerminamiller at gmail.com
>>> > wrote:
>>>
>>>> Sorry to jump in on this discussion so late down the thread (on
>>>> vacation with limited wifi) but I was the one who made the link in that
>>>> particular commit. Should I continue I using links and, if so, what's the
>>>> best way to do it without causing trouble? Thanks! - Nermina
>>>>
>>>>
>>>> On Friday, July 19, 2013, Lorin Hochstein wrote:
>>>>
>>>>>
>>>>> On Thu, Jul 18, 2013 at 8:01 PM, David Cramer <
>>>>> david.cramer at rackspace.com> wrote:
>>>>>
>>>>>> On 07/18/2013 05:43 PM, Denis Bradford wrote:
>>>>>> > While you're brainstorming, I'm curious why we don't use olinks,
>>>>>> since
>>>>>> > it's designed to handle cross-document references like this.
>>>>>>
>>>>>> Funny you should mention that :-) It's next on my list and I've been
>>>>>> trying to get to it all summer, but one thing or another keeps coming
>>>>>> up. It's still a high priority for me though.
>>>>>>
>>>>>> As I understand it, olinks would not have changed anything in this
>>>>>> case
>>>>>> however. The document would have passed the gate job (which
>>>>>> effectively
>>>>>> would no longer check links at all), but still failed in the maven
>>>>>> plugin since the target would be missing.
>>>>>>
>>>>>> What happened here is the system worked and prevented a mistake by
>>>>>> alerting us to a real problem.
>>>>>>
>>>>>>
>>>>> Just to be clear... the system *didn't* work here: docs were committed
>>>>> to master that broke the build, and that should never happen. We really
>>>>> need a maven job that gate on master to prevent this in the future.
>>>>>
>>>>> Lorin
>>>>>
>>>>> --
>>>>> Lorin Hochstein
>>>>> Lead Architect - Cloud Services
>>>>> Nimbis Services, Inc.
>>>>> www.nimbisservices.com
>>>>>
>>>>
>>>
>>>
>>> --
>>> Lorin Hochstein
>>> Lead Architect - Cloud Services
>>> Nimbis Services, Inc.
>>> www.nimbisservices.com
>>>
>>
>
>
> --
> Lorin Hochstein
> Lead Architect - Cloud Services
> Nimbis Services, Inc.
> www.nimbisservices.com
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130719/56143fc5/attachment.html>