yahoo-eng-team team mailing list archive
-
yahoo-eng-team team
-
Mailing list archive
-
Message #68114
[Bug 1716005] Re: validate doc links as part of a release
Reviewed: https://review.openstack.org/505327
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=fc6e9a71d80aaed4a804c4922cc2094b9e6d1857
Submitter: Jenkins
Branch: master
commit fc6e9a71d80aaed4a804c4922cc2094b9e6d1857
Author: Boden R <bodenvmw@xxxxxxxxx>
Date: Tue Sep 19 10:37:29 2017 -0600
add doc link validation to release checklist and tox
This patch updates our doc conf.py to support the linkcheck builder in
addition to adding a new 'linkcheck' target in tox to run the builder.
Also the release checklist is updated suggesting the linkcheck tox
target be run prior to a release.
Change-Id: Ia7c282b7331f0b624bb3324f27dfec223cf414f7
Closes-Bug: #1716005
** Changed in: neutron
Status: In Progress => Fix Released
--
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 as part of a release
Status in neutron:
Fix Released
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
References