Bug 2028490 - RDP documentation has unnecessary prerequisites and is not consistent with SSH
Summary: RDP documentation has unnecessary prerequisites and is not consistent with SSH
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Documentation
Version: 4.8.3
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
: 4.11.2
Assignee: Shikha Jhala
QA Contact: Satyajit Bulage
Whiteboard: bug tracker 4.12
Depends On: 2028042 2029378
TreeView+ depends on / blocked
Reported: 2021-12-02 13:47 UTC by Petr Horáček
Modified: 2023-01-24 20:56 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Last Closed: 2023-01-24 20:56:23 UTC
Target Upstream Version:

Attachments (Terms of Use)

System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker CNV-15162 0 None None None 2021-12-07 05:25:57 UTC

Description Petr Horáček 2021-12-02 13:47:59 UTC
Document URL: https://docs.openshift.com/container-platform/4.9/virt/virtual_machines/virt-accessing-vm-consoles.html

Section Number and Name: "Connecting to the RDP console" and "Connecting to a Windows virtual machine with an RDP console"

Describe the issue: 
There are two issues related to our RDP documentation. First is that the UI based documentation describes dependencies that are not really required, we should fix it to make the guide relevant to bigger portion of customers. Second is that the CLI based documentation suffers the same problem plus it is not  consistent with our SSH documentation despite having almost the same procedure and requirements.

Suggestions for UI docs improvement: 
- Once an underlying UI bug https://bugzilla.redhat.com/show_bug.cgi?id=2028042 is resolved, remove the prerequisites. 
- Remove the 6. step "In the Network Interface list, select the layer-2 NIC.", so the network is kept on the default.

Suggestions for CLI docs improvement: 
- Turn this section to the same format as is used in the "Accessing a virtual machine via SSH with YAML configurations". Apart from changing the text describing SSH to RDP, change the port 22 to 3389 and instead of "ssh fedora.55.101 -p 30093" connect using an RDP client as described in the last two steps of the current guide.

Comment 3 Shikha Jhala 2023-01-19 14:15:51 UTC
@phoracek PR is ready for your review: https://github.com/openshift/openshift-docs/pull/54553. Thanks!

Comment 4 Petr Horáček 2023-01-20 08:46:08 UTC
Sure! I left some small remarks on the PR.

Comment 5 Shikha Jhala 2023-01-23 13:00:09 UTC
@phoracek I have updated the PR per your suggestions. @sbulage Can you review the PR from QE perspective: https://github.com/openshift/openshift-docs/pull/54553. Thanks!

Comment 7 Shikha Jhala 2023-01-24 20:56:23 UTC
Peer review complete. PR is merged.

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