Bug 1440131 - [TEXT] - Wrong link for installation guide on engine-setup
Summary: [TEXT] - Wrong link for installation guide on engine-setup
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: rhevm-setup-plugins
Version: 4.1.0
Hardware: All
OS: All
high
medium
Target Milestone: ovirt-4.2.1
: ---
Assignee: Yedidyah Bar David
QA Contact: Pavel Novotny
URL:
Whiteboard:
Depends On:
Blocks: 1445765
TreeView+ depends on / blocked
 
Reported: 2017-04-07 11:10 UTC by Lukas Svaty
Modified: 2019-05-16 13:08 UTC (History)
12 users (show)

Fixed In Version: rhvm-setup-plugins-4.2.2-1.el7ev
Doc Type: No Doc Update
Doc Text:
undefined
Clone Of:
: 1445765 (view as bug list)
Environment:
Last Closed: 2018-05-15 17:33:21 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:
pnovotny: testing_plan_complete-


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHEA-2018:1473 0 None None None 2018-05-15 17:34:17 UTC

Description Lukas Svaty 2017-04-07 11:10:08 UTC
Description of problem:
          Welcome to the RHEV 4.1 setup/upgrade.
          Please read the RHEV 4.1 install guide
          https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/4.1/html/Installation_Guide/index.html.
          Please refer to the RHEV Upgrade Helper application
          https://access.redhat.com/labs/rhevupgradehelper/ which will guide you in the upgrading process.
          Would you like to proceed? (Yes, No) [Yes]: 


this one:
https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/4.1/html/Installation_Guide/index.html.
should be:
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.1/html/installation_guide/index.html

Comment 4 Lukas Svaty 2017-11-03 15:02:41 UTC
QE does not have 4.2 downstream build

Comment 7 Yedidyah Bar David 2017-12-03 08:00:59 UTC
(In reply to Lukas Svaty from comment #6)
> provided link:
>          
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html/installation_guide/index.html
> 
> 404 :(

It will go live only around GA time, so should be ok. Lucy - can you please confirm that this is the URL we should point at? Thanks.

Comment 8 Lucy Bopf 2017-12-04 01:54:34 UTC
(In reply to Yedidyah Bar David from comment #7)
> (In reply to Lukas Svaty from comment #6)
> > provided link:
> >          
> > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > html/installation_guide/index.html
> > 
> > 404 :(
> 
> It will go live only around GA time, so should be ok. Lucy - can you please
> confirm that this is the URL we should point at? Thanks.

Yep, minus the '/index.html', which isn't required anymore. So:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/installation_guide

(Also not live yet)

Comment 10 Yedidyah Bar David 2017-12-04 06:48:08 UTC
(In reply to Lucy Bopf from comment #8)
> (In reply to Yedidyah Bar David from comment #7)
> > (In reply to Lukas Svaty from comment #6)
> > > provided link:
> > >          
> > > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > > html/installation_guide/index.html
> > > 
> > > 404 :(
> > 
> > It will go live only around GA time, so should be ok. Lucy - can you please
> > confirm that this is the URL we should point at? Thanks.
> 
> Yep, minus the '/index.html', which isn't required anymore. So:
> 
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html/installation_guide

But would it not work, with '/index.html'? If so, we need a patch.

Is it possible to ask for a permanent, stable set of redirections?

Say, something like:

https://access.redhat.com/redirect_to/RHV_docs/4.2-instguide

That will currently either redirect to the final intended target
and return a 404, or even better, will redirect to a page saying
that 4.2 is not released yet? Perhaps you are not the one to ask,
not sure.

Comment 11 Lucy Bopf 2017-12-05 06:03:39 UTC
(In reply to Yedidyah Bar David from comment #10)
> (In reply to Lucy Bopf from comment #8)
> > (In reply to Yedidyah Bar David from comment #7)
> > > (In reply to Lukas Svaty from comment #6)
> > > > provided link:
> > > >          
> > > > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > > > html/installation_guide/index.html
> > > > 
> > > > 404 :(
> > > 
> > > It will go live only around GA time, so should be ok. Lucy - can you please
> > > confirm that this is the URL we should point at? Thanks.
> > 
> > Yep, minus the '/index.html', which isn't required anymore. So:
> > 
> > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > html/installation_guide
> 
> But would it not work, with '/index.html'? If so, we need a patch.

Actually, I've now checked this, and adding /index.html does work: it just redirects to /index (i.e. the top of the book) So no need to patch.

> 
> Is it possible to ask for a permanent, stable set of redirections?
> 
> Say, something like:
> 
> https://access.redhat.com/redirect_to/RHV_docs/4.2-instguide
> 
> That will currently either redirect to the final intended target
> and return a 404, or even better, will redirect to a page saying
> that 4.2 is not released yet? Perhaps you are not the one to ask,
> not sure.

Our link format has certainly changed more times recently than is ideal.

The link style I mentioned above (the one that is minus /index.html) is, as far as I am aware, going to be the permanent style going forward. Unless we rename the guide (unlikely, and we would make it known), the only thing that should change release over release now is the version number.

We don't really have the scope to maintain a set of redirects, unfortunately. If you have a date or milestone by which you generally need the link confirmed, we can include it in our project planning going forward.

Comment 12 Yedidyah Bar David 2017-12-05 08:34:38 UTC
(In reply to Lucy Bopf from comment #11)
> (In reply to Yedidyah Bar David from comment #10)
> > (In reply to Lucy Bopf from comment #8)
> > > (In reply to Yedidyah Bar David from comment #7)
> > > > (In reply to Lukas Svaty from comment #6)
> > > > > provided link:
> > > > >          
> > > > > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > > > > html/installation_guide/index.html
> > > > > 
> > > > > 404 :(
> > > > 
> > > > It will go live only around GA time, so should be ok. Lucy - can you please
> > > > confirm that this is the URL we should point at? Thanks.
> > > 
> > > Yep, minus the '/index.html', which isn't required anymore. So:
> > > 
> > > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > > html/installation_guide
> > 
> > But would it not work, with '/index.html'? If so, we need a patch.
> 
> Actually, I've now checked this, and adding /index.html does work: it just
> redirects to /index (i.e. the top of the book) So no need to patch.

Thanks.

> 
> > 
> > Is it possible to ask for a permanent, stable set of redirections?
> > 
> > Say, something like:
> > 
> > https://access.redhat.com/redirect_to/RHV_docs/4.2-instguide
> > 
> > That will currently either redirect to the final intended target
> > and return a 404, or even better, will redirect to a page saying
> > that 4.2 is not released yet? Perhaps you are not the one to ask,
> > not sure.
> 
> Our link format has certainly changed more times recently than is ideal.
> 
> The link style I mentioned above (the one that is minus /index.html) is, as
> far as I am aware, going to be the permanent style going forward. Unless we
> rename the guide (unlikely, and we would make it known), the only thing that
> should change release over release now is the version number.

OK.

I'll patch anyway just in case, also in case future versions will not work with '/index.html'.

> 
> We don't really have the scope to maintain a set of redirects,
> unfortunately. If you have a date or milestone by which you generally need
> the link confirmed, we can include it in our project planning going forward.

Not sure we have any, and if we do, it's up to QE/PM to say.

Also, I am wondering if we want to "fix" current bug also for 4.2-Beta. Will the URL be:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2-Beta/html/installation_guide/

?

Yaniv, do we want to?

Price is having to fix again between last downstream 4.2 Beta and GA. If we don't, beta users will have a bad link, as 4.2 isn't there yet. Or perhaps we can ask doc team to redirect 4.2 to 4.2-Beta for now.

Comment 13 Yaniv Lavi 2017-12-08 17:03:32 UTC
(In reply to Yedidyah Bar David from comment #12)
> 
> Yaniv, do we want to?
> 
> Price is having to fix again between last downstream 4.2 Beta and GA. If we
> don't, beta users will have a bad link, as 4.2 isn't there yet. Or perhaps
> we can ask doc team to redirect 4.2 to 4.2-Beta for now.

I believe we worked with redirects in the past, let's include the url for the GA and link it to beta until the GA docs are there.

Comment 14 Yedidyah Bar David 2017-12-10 07:46:11 UTC
Very well.

Lucy, can you please handle that? Want me to open tickets/bugs (no idea where)?

1. Create a redirection from 4.2 to 4.2-Beta

2. Remove it once 4.2 is GA and 4.2 docs are published

Thanks.

Comment 15 Yedidyah Bar David 2017-12-18 09:43:10 UTC
Moving back to QE as Lucy confirmed in comment 11 that current link is ok.

It would still be nice to create a redirection 4.2-Beta -> 4.2, for the Beta users, but this does not prevent verification of current bug.

Comment 16 Lukas Svaty 2018-01-19 16:16:52 UTC
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/installation_guide/index.html -> 404
https://access.redhat.com/labs/rhevupgradehelper/ -> ok

moving back to ASSIGNED, as the document is not available

Another thing is message
"""
  Welcome to the RHV 4.2 setup/upgrade.
  Please read the RHV 4.2 install guide
  https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/installation_guide/index.html
"""

Is not shown in case of setup (non-upgrade), didi would you like a bug for that, or can it be fixed within this one?

Comment 17 Lukas Svaty 2018-01-19 16:27:13 UTC
apologies, forgot to add tested versions:

rhn-setup-2.0.2-20.el7.noarch
ovirt-setup-lib-1.1.4-1.el7ev.noarch
ovirt-engine-setup-plugin-ovirt-engine-common-4.2.1.2-0.1.el7.noarch
rhvm-setup-plugins-4.2.1-1.el7ev.noarch
ovirt-engine-setup-plugin-ovirt-engine-4.2.1.2-0.1.el7.noarch
ovirt-engine-setup-4.2.1.2-0.1.el7.noarch
ovirt-engine-setup-base-4.2.1.2-0.1.el7.noarch

Comment 18 Yedidyah Bar David 2018-01-21 08:33:39 UTC
(In reply to Lukas Svaty from comment #16)
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html/installation_guide/index.html -> 404
> https://access.redhat.com/labs/rhevupgradehelper/ -> ok
> 
> moving back to ASSIGNED, as the document is not available

Please see comment 8, then comment 11, then comment 15.

> 
> Another thing is message
> """
>   Welcome to the RHV 4.2 setup/upgrade.
>   Please read the RHV 4.2 install guide
>  
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html/installation_guide/index.html
> """
> 
> Is not shown in case of setup (non-upgrade), didi would you like a bug for
> that, or can it be fixed within this one?

Feel free to file a bug, but AFAIU this is by design, reasoning being that clean setups are "easy" but upgrades are "hard". See also bug 1146636. If you do, perhaps ask CEE if they want this, and if they do, how they want this to behave - e.g. have a new "Setup helper" (separate from "Upgrade helper") etc.

Comment 19 Lukas Svaty 2018-01-22 07:42:52 UTC
Agree, however, the bug cannot be ON_QA, as we do not have proper documentation yet. Moving to MODIFIED, Lucy can you move to ON_QA once we have it updated?

Comment 20 Sandro Bonazzola 2018-01-31 10:25:07 UTC
(In reply to Lukas Svaty from comment #19)
> Agree, however, the bug cannot be ON_QA, as we do not have proper
> documentation yet. Moving to MODIFIED, Lucy can you move to ON_QA once we
> have it updated?

Moving to documentation team

Comment 22 Lucy Bopf 2018-02-20 06:59:52 UTC
Very sorry for the delay here. I was about to request the redirect when I came back to see a 'Fixed in Version' value defined.

Sandro, can you confirm whether the redirect from the GA (4.2) link to Beta (4.2-Beta) link is still required, or was something altered in the code to work around this?

Comment 23 Yedidyah Bar David 2018-02-20 07:16:12 UTC
(In reply to Lucy Bopf from comment #22)
> Very sorry for the delay here. I was about to request the redirect when I
> came back to see a 'Fixed in Version' value defined.
> 
> Sandro, can you confirm whether the redirect from the GA (4.2) link to Beta
> (4.2-Beta) link is still required,

I think it is

> or was something altered in the code to
> work around this?

Nothing changed so far.

Comment 24 Sandro Bonazzola 2018-02-20 09:24:22 UTC
Didi already answered, dropping needinfo.

Comment 25 Pavel Novotny 2018-02-20 15:20:14 UTC
The docs link provided in engine-setup (rhvm-setup-plugins-4.2.2-1.el7ev.noarch) is following:

[ INFO  ] Stage: Environment customization
         
          Welcome to the RHV 4.2 setup/upgrade.
          Please read the RHV 4.2 install guide
          https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/installation_guide/index.html


The URL is for GA (/4.2/) and reading the recent discussion here it should be redirected to Beta (/4.2-Beta/). Sounds OK to me.

As Lucy requested the redirect just today, I am moving this bug to MODIFIED for now and after
the request is resolved, feel free to move it back to ON_QA and I will check the links again.

Comment 26 Lucy Bopf 2018-02-21 00:56:08 UTC
Thanks, Didi and Pavel for confirming.

I will provide an update here when the redirect has been added.

Comment 28 Lucy Bopf 2018-02-22 06:50:24 UTC
(In reply to Lucy Bopf from comment #26)
> Thanks, Didi and Pavel for confirming.
> 
> I will provide an update here when the redirect has been added.

The redirect is now in place.

https://access.redhat.com/documentation/en-us/red_hat_
virtualization/4.2/html/installation_guide/index.html

redirects to

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2-beta/html/installation_guide/

Comment 29 Pavel Novotny 2018-02-27 17:47:58 UTC
Verified in
rhvm-4.2.2.1-0.1.el7.noarch
rhvm-setup-plugins-4.2.3-1.el7ev.noarch

Verified that the link provided in engine-setup is now properly redirected to the beta Installation Guide:

# engine-setup
...
Please read the RHV 4.2 install guide
https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/installation_guide/index.html
^^^
  redirects to https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2-beta/html/installation_guide/

Comment 32 errata-xmlrpc 2018-05-15 17:33:21 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, 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/RHEA-2018:1473

Comment 33 Franta Kust 2019-05-16 13:08:53 UTC
BZ<2>Jira Resync


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