Bug 1729922

Summary:	[Docs] Networking Guide: ToC hyperlinks broken
Product:	Red Hat OpenStack	Reporter:	Thom Carlin <tcarlin>
Component:	documentation	Assignee:	Greg Rakauskas <gregraka>
Status:	CLOSED CURRENTRELEASE	QA Contact:	RHOS Documentation Team <rhos-docs>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	10.0 (Newton)	CC:	ccopello, dcadzow, dmacpher, gregraka, jamsmith, lbolger, mburns, tcarlin
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2019-07-23 17:53:23 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1715822

Description Thom Carlin 2019-07-15 10:31:38 UTC

Description of problem:

For https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/networking_guide/index many links are broken

Version-Release number of selected component (if applicable):

10-z

How reproducible:

100% for specific links

Steps to Reproduce:
1. Navigate to https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/networking_guide/index
2. Select link (at random) in panel on left
3. Watch where the link goes to

Actual results:

Most links resolve to top of document

Expected results:

All links resolve to corresponding section of the document (i.e. Chapter 11 actually goes to Chapter 11, not Section 2.3.  For this specific case, the resolution URL is https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/networking_guide/index#security_groups which suggests a ToC generation issue)

Additional info:

Comment 3 Greg Rakauskas 2019-07-23 17:53:23 UTC

Hi Thom,

Thanks so much for noticing this defect and telling the RHOSP Doc team!

It turns out that this error was caused by an AsciiDoc tagging error.

Thanks to Dan McPherson who discovered the fix!

We have fixed it in OSP 10, 9, and 8.

The fixes are live and customers can see the fixes here:

 - OSP 10
   https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/networking_guide/index

 - OSP  9
   https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/9/html-single/networking_guide/index

 - OSP  8
   https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/9/html-single/networking_guide/index   


Thanks again!
--Greg