Skip to content

Added guidance on omitting part of an output #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julian-cable merged 3 commits into from
Jul 14, 2023
Merged

Added guidance on omitting part of an output #500

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a862a12
Added guidance on omitting part of an output
julian-cable Jul 13, 2023
301dde4
Updated wording
julian-cable Jul 14, 2023
0e71014
Typo fix
julian-cable Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,26 @@ $ vi myFile.txt
--initial-dashboard-password=DASHBOARD_PASSWORD --dashboard-password-noupdate \
--allow-fqdn-hostname</screen>

</example>

</section>

<section>
<title>Omitting Part of Output</title>
<para>
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{nbsp}Hat uses the <emphasis>...output omitted...</emphasis> notation, starting and ending with an ellipsis, and highlighted in italics.
</para>

<example><title>Notation for Excluding Part of Output</title>
<screen>[student@workstation image]$ podman build --layers=false -t nexus .
STEP 1: FROM ubi8/ubi:8.3
Getting image source signatures
<emphasis>...output omitted...</emphasis>
STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest</screen>

</example>

</section>
Expand Down