Bug 1614510 - [Docs][RN] Mention ovirt-cli / rhevm-shell is deprecated in RHV 4.2 release notes
Summary: [Docs][RN] Mention ovirt-cli / rhevm-shell is deprecated in RHV 4.2 release n...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.2.4
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: ovirt-4.2.6
: ---
Assignee: Tahlia Richardson
QA Contact: Emma Heftman
URL:
Whiteboard: docs-accepted
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-08-09 18:42 UTC by Marina Kalinin
Modified: 2021-09-09 15:23 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-30 04:23:05 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:
lsvaty: testing_plan_complete-


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1399709 0 medium CLOSED Emit not supported message when executing ovirt-engine-cli scripts 2022-06-22 13:40:58 UTC
Red Hat Issue Tracker RHV-36855 0 None None None 2021-09-09 15:23:24 UTC
Red Hat Knowledge Base (Solution) 3546021 0 None None None 2018-08-09 18:50:24 UTC

Internal Links: 1399709

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.


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