From 07658aa1fed17446d0d9d7359abd6a315e0359cb Mon Sep 17 00:00:00 2001 From: julian-cable Date: Fri, 20 Sep 2024 17:34:00 +0100 Subject: [PATCH 1/3] Updates for dashes, terminal, omitting output --- en-US/C.xml | 3 ++- en-US/D.xml | 16 +++------------- en-US/Design.xml | 37 +++++++++++++++++++++++++++++++++++-- en-US/E.xml | 4 ++-- en-US/T.xml | 14 +++++++++++--- 5 files changed, 53 insertions(+), 21 deletions(-) diff --git a/en-US/C.xml b/en-US/C.xml index bee0b62..f9567ff 100644 --- a/en-US/C.xml +++ b/en-US/C.xml @@ -335,12 +335,13 @@ command line, command prompt, command-line - For an explanation of how to use these terms, refer to the appropriate entries in IBM Style + For an explanation of how to use these terms, refer to the appropriate entries in IBM Style . + Use "command line" as a noun, and use "command-line" as an adjective. diff --git a/en-US/D.xml b/en-US/D.xml index ee4e3b3..9bb63f1 100644 --- a/en-US/D.xml +++ b/en-US/D.xml @@ -23,19 +23,9 @@ dash - In technical publications, IBM Style - - - - - recommends not to use em dashes. Use a colon or other suitable punctuation. - En dashes are used to show a range. - Refer to Dashes in IBM Style - - - - - . + In technical content, use a dash to show a range. + Otherwise, use a colon or other suitable punctuation. + Do not use em dashes. diff --git a/en-US/Design.xml b/en-US/Design.xml index 9753ef7..4a58e2e 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -529,16 +529,49 @@ The ARN in the preceding output is different on your system. For the sake of brevity, do not show all output to the user in all cases, but only those parts of any output that are relevant to the context that is described. Where output is not included, place a marker to show that information is purposely excluded. When shortening the output, use a consistent notation. - Red Hat uses the ...output omitted... notation, starting and ending with an ellipsis, and highlighted in italics. + For omitting horizontal lines of output, Red Hat uses the ...output omitted... notation, starting and ending with an ellipsis, and highlighted in italics. -Notation for Excluding Part of Output +Notation for Omitting Horizontal Output [student@workstation image]$ podman build --layers=false -t nexus . STEP 1: FROM ubi8/ubi:8.3 Getting image source signatures ...output omitted... STEP 14: COMMIT ...output omitted... localhost/nexus:latest + + + + For omitting vertical columns of output, Red Hat instead uses the notation of an ellipsis (...) without highlighting. + + +Notation for Omitting Vertical Output + [user@host ~]$ oc get csv +NAME DISPLAY ... +barbican-operator.v1.0.0 Barbican Operator ... +cinder-operator.v1.0.0 Cinder Operator ... +designate-operator.v1.0.0 Designate Operator ... +glance-operator.v1.0.0 Glance Operator ... +heat-operator.v1.0.0 Heat Operator ... +horizon-operator.v1.0.0 Horizon Operator ... +infra-operator.v1.0.0 OpenStack Infra ... +ironic-operator.v1.0.0 Ironic Operator ... +keystone-operator.v1.0.0 Keystone Operator ... +manila-operator.v1.0.0 Manila Operator ... +mariadb-operator.v1.0.0 MariaDB Operator ... +metallb-operator.v4.14.0-202407091409 MetalLB Operator ... +neutron-operator.v1.0.0 Neutron Operator ... +nova-operator.v1.0.0 Nova Operator ... +octavia-operator.v1.0.0 Octavia Operator ... +openstack-ansibleee-operator.v1.0.0 OpenStackAnsibleEE ... +openstack-baremetal-operator.v1.0.0 OpenStack Baremetal Operator ... +openstack-operator.v1.0.0 OpenStack ... +ovn-operator.v1.0.0 OVN Operator ... +placement-operator.v1.0.0 Placement Operator ... +rabbitmq-cluster-operator.v0.0.1 RabbitMQ Cluster Operator ... +swift-operator.v1.0.0 Swift operator ... +telemetry-operator.v1.0.0 Telemetry Operator ... + diff --git a/en-US/E.xml b/en-US/E.xml index e8e5754..bf7cb4f 100644 --- a/en-US/E.xml +++ b/en-US/E.xml @@ -46,7 +46,7 @@ - + enter diff --git a/en-US/T.xml b/en-US/T.xml index f56a4e1..31ae9b5 100644 --- a/en-US/T.xml +++ b/en-US/T.xml @@ -92,16 +92,24 @@ terminal - n. Do not use to describe where to type commands. Use "command line" instead. + n. Use "terminal" to refer to a text-based interface where typed instructions are entered, or to refer to a session of this type. + For example, "Open a terminal and log in to your OpenShift cluster", or "The exercise file captures any error messages from your terminal". - + + Use "command line" instead to refer to the prompt where commands are entered. + For example, "Copy the command from the web console and paste it on the command line", or "The following command creates a generic secret that contains key-value pairs from literal values that are typed on the command line". + + + From f541ca17f5f3dba731f39cb1222a24e746432aab Mon Sep 17 00:00:00 2001 From: julian-cable Date: Fri, 20 Sep 2024 17:54:10 +0100 Subject: [PATCH 2/3] add shell prompt example --- en-US/T.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en-US/T.xml b/en-US/T.xml index 31ae9b5..3dd0434 100644 --- a/en-US/T.xml +++ b/en-US/T.xml @@ -96,8 +96,8 @@ For example, "Open a terminal and log in to your OpenShift cluster", or "The exercise file captures any error messages from your terminal". - Use "command line" instead to refer to the prompt where commands are entered. - For example, "Copy the command from the web console and paste it on the command line", or "The following command creates a generic secret that contains key-value pairs from literal values that are typed on the command line". + Use "command line" or "shell prompt" instead to refer to the prompt where commands are entered. + For example, "Copy the command from the web console and paste it on the command line", or "If you enter your username and password correctly, then you log in and get a shell prompt". diff --git a/en-US/S.xml b/en-US/S.xml index bd073ff..1b40ac8 100644 --- a/en-US/S.xml +++ b/en-US/S.xml @@ -299,7 +299,13 @@ shell prompt - Refers to the character at the beginning of the command line, and indicates that the shell is ready to accept commands. Do not use "command prompt", "terminal", or "shell". + Refers to the character at the beginning of the command line, and indicates that the shell is ready to accept commands. Do not use "command prompt" or "shell". + + + For example, "If you enter your username and password correctly, then you log in and get a shell prompt." + + + Refer also to and to . diff --git a/en-US/T.xml b/en-US/T.xml index 3dd0434..b966f4c 100644 --- a/en-US/T.xml +++ b/en-US/T.xml @@ -93,11 +93,19 @@ n. Use "terminal" to refer to a text-based interface where typed instructions are entered, or to refer to a session of this type. + + For example, "Open a terminal and log in to your OpenShift cluster", or "The exercise file captures any error messages from your terminal". - Use "command line" or "shell prompt" instead to refer to the prompt where commands are entered. - For example, "Copy the command from the web console and paste it on the command line", or "If you enter your username and password correctly, then you log in and get a shell prompt". + + Use "command line" instead to refer to the place where commands are entered. + + + For example, "Copy the command from the web console and paste it on the command line." + + + Refer also to and to .