validate doc links as part of a release

[Boden R]

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

[Boden R (boden)]

We talked about this at the Denver PTG. The decision was just to update the neutron release checklist to include checking doc links manually with some tool.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/505327

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/506342

[OpenStack Infra (hudson-openstack)]

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 <email address hidden>
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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/506342
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=b4ec3d0ebd62eb1341690df0cb4956c35f6e1ad5
Submitter: Jenkins
Branch: master

commit b4ec3d0ebd62eb1341690df0cb4956c35f6e1ad5
Author: Boden R <email address hidden>
Date: Thu Sep 21 13:45:59 2017 -0600

    add api ref and doc link validation to release

    This patch adds a linkcheck target to our tox.ini that validates URLs
    in both our doc and api-ref html. In addition the release checklist is
    updated to suggest this should be done prior to releasing.

    Partial-Bug: #1716005

    Change-Id: I48b4dde3ffd1902a31bf6f352b7143d4c15f3443

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron 12.0.0.0b1 development milestone.