yahoo-eng-team team mailing list archive

[Boden R <bodenvmw@xxxxxxxxx>]

Public bug reported:

Today we have no validation of links (internal, relative or static) as
part of our doc build. As a result we can end up with dead links over
time that are typically noticed by our users... Less than optimal.

As part of the comments in [1], it was suggested we try to validate
links in the gate. While sounding simple it actually becomes more
complex [2] given eventlet usage, considerations for periodic job, etc..

This bug is to track the work to add some sort of validation during our
build, perhaps as a periodic job.


[1] https://review.openstack.org/#/c/500095/
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-September/121833.html

** Affects: neutron
     Importance: Undecided
         Status: New


** Tags: doc

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1716005

Title:
  validate doc links in the gate

Status in neutron:
  New

Bug description:
  Today we have no validation of links (internal, relative or static) as
  part of our doc build. As a result we can end up with dead links over
  time that are typically noticed by our users... Less than optimal.

  As part of the comments in [1], it was suggested we try to validate
  links in the gate. While sounding simple it actually becomes more
  complex [2] given eventlet usage, considerations for periodic job,
  etc..

  This bug is to track the work to add some sort of validation during
  our build, perhaps as a periodic job.

  
  [1] https://review.openstack.org/#/c/500095/
  [2] http://lists.openstack.org/pipermail/openstack-dev/2017-September/121833.html

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1716005/+subscriptions