docs: enrich command sections with tldr quick-reference admonitions - #4
Open
mtahle wants to merge 1 commit into
Open
docs: enrich command sections with tldr quick-reference admonitions#4mtahle wants to merge 1 commit into
mtahle wants to merge 1 commit into
Conversation
Add collapsible `??? example "tldr: <command>"` admonitions sourced from tldr-pages (https://tldr.sh) throughout the docs so readers can access concise, practical command examples without leaving the page. linux/troubleshooting-tools.md: - ping, telnet, curl — admonition after each section heading - New "Quick Reference (tldr)" subsection before Essential Network Commands with admonitions for: ip, ss, netstat, lsof, dig, nslookup, host, traceroute, mtr, iperf3, tcpdump, nmap, nc linux/introduction.md: - apt — after the Package Management distribution table - systemctl — after the Service Management code block - ssh, ssh-keygen — before the SSH Security code block linux/web-hosting.md: - ufw — before the Apache firewall configuration block containers/introduction.md: - docker — before the Docker Fundamentals section - kubectl, helm — before the Docker Swarm section (in Orchestration) containers/security.md: - trivy — at the top of the page before Container Security Fundamentals automation/introduction.md: - git — at the top of the page before CI/CD Concepts
There was a problem hiding this comment.
Pull request overview
This PR enriches multiple documentation pages by adding collapsible “tldr” quick-reference admonitions for common DevOps/Linux/container/automation commands, improving scan-ability and making key commands easier to find alongside longer explanations.
Changes:
- Add “tldr” quick-reference admonitions for core Linux commands (e.g.,
apt,systemctl,ssh) and networking tools (e.g.,ping,telnet,curl, plus a broader “Quick Reference” section). - Add “tldr” command blocks for container and security tooling (e.g.,
docker,kubectl,helm,trivy). - Add a “tldr” block for
gitin the CI/CD & automation introduction.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/linux/web-hosting.md | Adds a ufw quick-reference block near the LAMP/Apache setup steps. |
| docs/linux/troubleshooting-tools.md | Adds multiple network troubleshooting “tldr” blocks and a consolidated quick-reference section. |
| docs/linux/introduction.md | Adds “tldr” blocks for apt, systemctl, ssh, and ssh-keygen in the Linux intro/security sections. |
| docs/containers/security.md | Adds a “tldr” block for trivy to the container security page. |
| docs/containers/introduction.md | Adds “tldr” blocks for docker, kubectl, and helm in the containers introduction. |
| docs/automation/introduction.md | Adds a “tldr” block for git at the start of the CI/CD & automation section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+203
to
+205
| # Allow from a specific IP | ||
| sudo ufw allow proto tcp from 192.168.0.4 to any port 22 | ||
|
|
Comment on lines
+132
to
+133
| systemctl status # Show all running services | ||
| systemctl status <unit> # Status of a specific service |
Comment on lines
+339
to
+340
| nc < file -l -p <port> # Send a file via listener | ||
| nc <host> <port> > out.file # Receive a file from a listener |
Comment on lines
+27
to
+28
| # Output as SARIF (for GitHub Code Scanning) | ||
| trivy image -f template -t "@sarif.tpl" -o report.sarif <image> |
Comment on lines
+134
to
+138
| systemctl start|stop|restart|reload <unit> # Manage a service | ||
| systemctl enable|disable <unit> # Enable/disable at boot | ||
| systemctl daemon-reload # Reload after unit file changes | ||
| systemctl is-active|is-enabled <unit> # Check service state | ||
| systemctl list-units --type service --state failed # List failed services |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.