Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 2.45 KB

conventions.adoc

File metadata and controls

88 lines (66 loc) · 2.45 KB

Documentation Conventions

This guide is intended to support a series of workshop exercises for individuals getting familiar with Red Hat Enterprise Linux 8. What follows are examples of how this document is formatted and expected to be consumed.

Tips, Notes & Warnings

💡
Extra info which could be helpful, but not essential for a given task or discussion
ℹ️
Special information to pay attention
⚠️
Critical information which could help you avoid major set backs

Executing tasks on the CLI

Input

Each block of commands to execute will be labeled with the expected user-id and host. To enhance cut & paste efficiency, the command prompt is omitted from each line.

[root@master ~]#
systemctl status sshd

Output

Sample output will be titled with 'Your output should look like this' (or 'Command Output') and also be indented to help with visual identification. Sometimes there will also be footnotes and/or callouts.

Command Output
    ● sshd.service - OpenSSH server daemon
       Loaded: loaded (/usr/lib/systemd/system/sshd.service; enabled; vendor preset: enabled)
       Active: active (running) since Tue 2019-02-26 12:04:16 EST; 27min ago // (1)
         Docs: man:sshd(8)
               man:sshd_config(5)
     Main PID: 3094 (sshd)
       CGroup: /system.slice/sshd.service
               └─3094 /usr/sbin/sshd -D
    ...<snip>...
  1. This is the line we are interested in with a special note

Alternate Commands

The workshop often provides workshop-scripts to ease certain complex tasks. This helps the class stay focused and reduces the likelihood of errors and disruptions to the workshop delivery. Honestly, we are not here to learn vi, emacs or start debates about the merits of sed and awk.

The native commands which the workshop-scripts utilize will be documented in the following way.

[root@master ~]#
workshop-service-status.sh
ℹ️

Native command(s) to verify system service

systemctl status sshd

End of Unit