Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1614510

Summary:	[Docs][RN] Mention ovirt-cli / rhevm-shell is deprecated in RHV 4.2 release notes
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Marina Kalinin <mkalinin>
Component:	Documentation	Assignee:	Tahlia Richardson <trichard>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Emma Heftman <eheftman>
Severity:	medium	Docs Contact:
Priority:	high
Version:	4.2.4	CC:	lsurette, mkalinin, pkovar, srevivo, tburke, trichard
Target Milestone:	ovirt-4.2.6	Keywords:	Triaged
Target Release:	---	Flags:	lsvaty: testing_plan_complete-
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	docs-accepted
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2018-08-30 04:23:05 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Docs	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Marina Kalinin 2018-08-09 18:42:20 UTC

According to bz#1399709, ovirt-shell, aka rhevm-shell is deprecated in 4.2, but there is no note about this in the release notes:

https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html-single/release_notes/#deprecated_functionality


It is very unclear and confusing customers and the support team what is the actual status.
Since the feature has been deprecated, we need to make sure it is documented in the official documentation.

Comment 1 Tahlia Richardson 2018-08-23 04:58:31 UTC

I'm not sure we can do much about that section of the release notes, since we use a script to generate it, so it relies on an engineering BZ for that release existing and having doc text. 

What I can do, though, is change the reference in the Product Guide (currently commented out, since the RHEVM Shell Guide isn't published right now) to state that the ovirt-shell is deprecated and due to be removed in a future release. 

As a longer-term goal (outside the scope of this BZ), I'd be interested in perhaps having a permanent section in the Release Notes that lists tech preview and deprecated features, with items only being removed when they are no longer in that state (currently we just have doc text from BZs that usually only appear in one release, while the feature may be in tech preview or deprecated state for many releases). However, such a section may require a lot of maintenance.

Comment 4 Marina Kalinin 2018-08-24 21:27:39 UTC

(In reply to Tahlia Richardson from comment #1)
> I'm not sure we can do much about that section of the release notes, since
> we use a script to generate it, so it relies on an engineering BZ for that
> release existing and having doc text. 
> 
> What I can do, though, is change the reference in the Product Guide
> (currently commented out, since the RHEVM Shell Guide isn't published right
> now) to state that the ovirt-shell is deprecated and due to be removed in a
> future release. 
This sounds great.
> 
> As a longer-term goal (outside the scope of this BZ), I'd be interested in
> perhaps having a permanent section in the Release Notes that lists tech
> preview and deprecated features, with items only being removed when they are
> no longer in that state (currently we just have doc text from BZs that
> usually only appear in one release, while the feature may be in tech preview
> or deprecated state for many releases). However, such a section may require
> a lot of maintenance.
I love this and we have a separate RFE for this behavior filed. Let me know if you don't have it.

Comment 6 Emma Heftman 2018-08-29 10:21:34 UTC

Verified and merged.

Comment 7 Tahlia Richardson 2018-08-30 04:23:05 UTC

Now published in https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/product_guide/accessing-rhv#supported_interfaces_for_read_and_write_access