Bug 1831954

Summary:	RESTAPI javadoc contains malformed link around oVirt guest agent
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Rolfe Dlugy-Hegwer <rdlugyhe>
Component:	ovirt-engine	Assignee:	Ori Liel <oliel>
Status:	CLOSED ERRATA	QA Contact:	Lucie Leistnerova <lleistne>
Severity:	low	Docs Contact:
Priority:	low
Version:	4.3.9	CC:	emarcus, lleistne, mperina, omachace, pelauter
Target Milestone:	ovirt-4.4.2	Keywords:	CodeChange, Reopened, ZStream
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	No Doc Update
Doc Text:		Story Points:	---
Clone Of:	1831949
Clones:	1831956 1833327 (view as bug list)		Environment:
Last Closed:	2020-09-23 16:11:10 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Infra	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:	1831949
Bug Blocks:	1831952, 1831956, 1833327

Description Rolfe Dlugy-Hegwer 2020-05-06 02:17:49 UTC

Description of problem:

Javadoc contains a malformed link:

```
==== statistics

Statistics data collected from this virtual machine.

Note that some statistics, notably `memory.buffered` and `memory.cached`
are available only when https://www.ovirt.org/documentation/internal/guest-agent/guest-agent[oVirt guest agent]<<<<<<<<<<<<<<<<<<<HERE
is installed in the virtual machine.

```

The link should be: https://www.ovirt.org/develop/internal/guest-agent/guest-agent.html.


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

How reproducible:
100%

Steps to Reproduce:
1.Open https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.3/html-single/rest_api_guide/
2. Ctrl+f search for oVirt guest agent


Actual results:

Current URL produces a 404 error

Expected results:

URL should open oVirt guest agent topic.

Additional info:

I am putting a temporary fix in the doc that will be erased next time we regenerate the API doc from the code. You must fix this in the source code.
Don't be fooled if you look at the current doc and it seems to be fixed.

Comment 1 Martin Perina 2020-05-07 07:55:23 UTC


*** This bug has been marked as a duplicate of bug 1831952 ***

Comment 2 Martin Perina 2020-05-07 12:28:57 UTC

OK, reopening, this has nothing with api-explorer, this content is included in ovirt-engine-api-model

Comment 3 Ori Liel 2020-05-08 10:00:05 UTC

In master branch the link is: 

  https://www.ovirt.org/documentation/vmm-guide/chap-Installing_Linux_Virtual_Machines.html#installing-guest-agents-and-drivers

  See:

     https://github.com/oVirt/ovirt-engine-api-model/blob/11b0a304d0ff57773d5621f55a80b625b9deffd2/src/main/java/types/Vm.java#L370

For consistency I'd prefer using that link in 4.3 as well. Does this seem ok to you?

Comment 4 Rolfe Dlugy-Hegwer 2020-05-08 12:46:01 UTC

(In reply to Ori Liel from comment #3)
> In master branch the link is: 

Uh oh. It looks like the downstream file where I found these broken links might out of date. When I look at the following history [1], I see 

> Fix documentation links …
> @machacekondra
> machacekondra committed on Jun 18, 2019

[1] https://github.com/oVirt/ovirt-engine-api-model/commits/11b0a304d0ff57773d5621f55a80b625b9deffd2/src/main/java/types/Vm.java

We should regenerate our model.adoc file and re-test for broken links. In the meantime, you should still verify the links on your side. I couple of the other bz's I created deal with websites or content that have been taken down.

Comment 5 Rolfe Dlugy-Hegwer 2020-05-26 14:09:11 UTC

The new link you are proposing looks correct. 
Please enclose the URL in <a> tags.
For details, see https://stackoverflow.com/questions/1082050/linking-to-an-external-url-in-javadoc

Comment 14 errata-xmlrpc 2020-09-23 16:11:10 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: Red Hat Virtualization security, bug fix, and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2020:3807