Bug 1833327 - [Docs] Regenerate model.adoc to pick up changes
Summary: [Docs] Regenerate model.adoc to pick up changes
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.3.9
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ovirt-4.4.1
: ---
Assignee: rhev-docs@redhat.com
QA Contact: rhev-docs@redhat.com
URL:
Whiteboard:
Depends On: 1831949 1831954
Blocks: 1831952 1831956
TreeView+ depends on / blocked
 
Reported: 2020-05-08 12:47 UTC by Rolfe Dlugy-Hegwer
Modified: 2020-08-05 11:23 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1831954
Environment:
Last Closed: 2020-08-05 11:23:52 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Rolfe Dlugy-Hegwer 2020-05-08 12:47:48 UTC
+++ This bug was initially created as a clone of Bug #1831954 +++

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.

--- Additional comment from Martin Perina on 2020-05-07 07:55:23 UTC ---



--- Additional comment from Martin Perina on 2020-05-07 12:28:57 UTC ---

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

--- Additional comment from Ori Liel on 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?

--- Additional comment from Rolfe Dlugy-Hegwer on 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 1 Rolfe Dlugy-Hegwer 2020-05-08 12:51:12 UTC
Regenerate model.adoc and test for broken links. 

If we find broken links, check the following bz's first. If the broken links are not already cited there, create new bz's.

https://bugzilla.redhat.com/show_bug.cgi?id=1831952:
https://bugzilla.redhat.com/show_bug.cgi?id=1831956
https://bugzilla.redhat.com/show_bug.cgi?id=1831954
https://bugzilla.redhat.com/show_bug.cgi?id=1831949


Note You need to log in before you can comment on or make changes to this bug.