"SR-IOV Passthrough For Networking" link incorrect

Bug #1737833 reported by Joe D'Andrea
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Low
Miguel Lavalle

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [x] I have a fix to the document that I can paste below including example: input and output.

Just remove the trailing slash from the "SR-IOV Passthrough For Networking" link:

Before: https://wiki.openstack.org/wiki/SR-IOV-Passthrough-For-Networking/
After: https://wiki.openstack.org/wiki/SR-IOV-Passthrough-For-Networking

-----------------------------------
Release: 11.0.3.dev21 on 2017-12-11 21:40
SHA: 1caba2d2e0f5c9752a858f28957d7dbb33640180
Source: https://git.openstack.org/cgit/openstack/neutron/tree/doc/source/contributor/internals/sriov_nic_agent.rst
URL: https://docs.openstack.org/neutron/pike/contributor/internals/sriov_nic_agent.html

Tags: doc
Revision history for this message
Slawek Kaplonski (slaweq) wrote :

It looks that issue is not in url placed in source as it don't have this trailing slash but maybe it's added when html page is build.

Changed in neutron:
status: New → Confirmed
importance: Undecided → Low
Revision history for this message
Miguel Lavalle (minsel) wrote :

It must be a problem building the document. Using this online tool http://rst.ninjs.org I took the following fragment from the doc and it renders fine, including the last link:

In most common deployments, there are compute and a network nodes.
Compute node can support VM connectivity via SR-IOV enabled NIC. SR-IOV NIC Agent manages
Virtual Functions admin state. Quality of service is partially implemented with the bandwidth limit
and minimum bandwidth rules. In the future it will manage additional settings, such as additional
quality of service rules, rate limit settings, spoofcheck and more.
Network node will be usually deployed with either Open vSwitch or Linux Bridge to support network node functionality.

Further Reading
---------------

* `Nir Yechiel - SR-IOV Networking – Part I: Understanding the Basics <http://redhatstackblog.redhat.com/2015/03/05/red-hat-enterprise-linux-openstack-platform-6-sr-iov-networking-part-i-understanding-the-basics/>`_
* `SR-IOV Passthrough For Networking <https://wiki.openstack.org/wiki/SR-IOV-Passthrough-For-Networking>`_

Miguel Lavalle (minsel)
Changed in neutron:
assignee: nobody → Miguel Lavalle (minsel)
Changed in neutron:
status: Confirmed → In Progress
Revision history for this message
Miguel Lavalle (minsel) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.openstack.org/527775
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=9eb7c3ef91d995aeeaa6d6dcec3c08fa8ef6bb3b
Submitter: Zuul
Branch: master

commit 9eb7c3ef91d995aeeaa6d6dcec3c08fa8ef6bb3b
Author: Miguel Lavalle <email address hidden>
Date: Wed Dec 13 14:08:03 2017 -0600

    Fix URL in SR-IOV internals doc

    The last link in the 'Further Reading' section of the SR-IOV internals
    document is not rendered properly. It gets a '/' at the end, that
    makes the link useless. It seems to be a problem with Sphinx. To
    work around it, the bullets are removed from the list of recommended
    documents for further reading

    Closes-Bug: #1737833

    Change-Id: I2116e82d60bc361583eab8e3809ec5f9eab6d11c

Changed in neutron:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/neutron 12.0.0.0b3

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

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.