# Rh Ssg Technical Examples

> Review Red Hat documentation for SSG technical example compliance — root privilege commands, YAML ellipses, IP addresses (RFC 5737 for IPv4, RFC 3849 for IPv6), MAC addresses (RFC 7042), code block quality (accurate, copy-paste friendly), and syntax highlighting. Use this skill when checking Red Hat docs for code examples, IP/MAC addresses in examples, sudo usage, YAML formatting, or source langu…

- **Type:** Skill
- **Install:** `agentstack add skill-opendatahub-io-docs-skills-rh-ssg-technical-examples`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [opendatahub-io](https://agentstack.voostack.com/s/opendatahub-io)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** Apache-2.0
- **Upstream author:** [opendatahub-io](https://github.com/opendatahub-io)
- **Source:** https://github.com/opendatahub-io/docs-skills/tree/main/skills/rh-ssg-technical-examples

## Install

```sh
agentstack add skill-opendatahub-io-docs-skills-rh-ssg-technical-examples
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Red Hat SSG: Technical Examples review skill

Review documentation for technical example compliance with the Red Hat Supplementary Style Guide.

## Checklist

### Commands requiring root privileges

- [ ] Commands requiring root privileges use `sudo` prefix, not `su -`
- [ ] Commands with `sudo` use the `$` prompt, not `#`
- [ ] Shell prompts alone are not the only indicator of required privilege level — step text, intro, or prerequisites also state the requirement
- [ ] If multiple commands require root, introductory text mentions it: "Some tasks in this procedure require root privileges..."

### Ellipses in YAML code blocks

- [ ] Ellipses in YAML use `# ...` (commented out), not bare `...`
- [ ] Bare `...` in YAML is reserved for "end of document" per YAML spec

### IP addresses and MAC addresses

- [ ] Example IPv4 addresses use RFC 5737 reserved ranges:
  - `192.0.2.0/24`
  - `198.51.100.0/24`
  - `203.0.113.0/24`
- [ ] Example IPv6 addresses use RFC 3849 reserved range: `2001:0DB8::/32`
- [ ] Example MAC addresses use RFC 7042 reserved ranges:
  - Unicast: `00:00:5E:00:53:00` – `00:00:5E:00:53:FF`
  - Multicast: `01:00:5E:90:10:00` – `01:00:5E:90:10:FF`
- [ ] No real IP or MAC addresses are used in examples

### Long code examples

- [ ] All code blocks are necessary, accurate, and helpful
- [ ] Code blocks are copy-and-paste friendly (except for user-replaced values)

### Syntax highlighting

- [ ] Source language is provided when supported: `[source,yaml]`, `[source,xml]`, etc.
- [ ] `bash` is NOT used for terminal commands — it misinterprets `#` as a comment instead of a root prompt
- [ ] Use `terminal` or `console` or omit the source language for shell commands

## How to use

1. Review only changed content and necessary context
2. For each issue found, cite the relevant SSG section
3. Mark issues as **required** (real IP addresses, `bash` source language for shell commands) or **[SUGGESTION]** (improvements)

## Example invocations

- "Review technical examples in this procedure module"
- "Check IP addresses and code blocks in proc_configuring-network.adoc"
- "Do an SSG technical examples review on the changed files"

## References

For detailed guidance, consult:
- [Red Hat Supplementary Style Guide: Technical examples](https://redhat-documentation.github.io/supplementary-style-guide/#technical-examples)

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [opendatahub-io](https://github.com/opendatahub-io)
- **Source:** [opendatahub-io/docs-skills](https://github.com/opendatahub-io/docs-skills)
- **License:** Apache-2.0

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-opendatahub-io-docs-skills-rh-ssg-technical-examples
- Seller: https://agentstack.voostack.com/s/opendatahub-io
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.