Compare commits
6 Commits
a010db3450
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f533aad0fa | ||
|
|
fa82dd816d | ||
|
|
0a574734f4 | ||
|
|
53aa4ef1fc | ||
|
|
1a1c20c734 | ||
|
|
9e652d76e6 |
@@ -1,4 +1,4 @@
|
||||
name: CI
|
||||
name: ci
|
||||
|
||||
on:
|
||||
push:
|
||||
@@ -9,27 +9,22 @@ on:
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: linux
|
||||
container: node:22-alpine
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Markdown lint
|
||||
run: |
|
||||
podman run --rm \
|
||||
-v "${{ github.workspace }}:/work:Z" \
|
||||
docker.io/davidanson/markdownlint-cli2:v0.17.2 \
|
||||
"**/*.md"
|
||||
- run: apk add --no-cache git
|
||||
- run: |
|
||||
git clone --depth 1 \
|
||||
-c "http.extraHeader=Authorization: token ${{ github.token }}" \
|
||||
"${{ github.server_url }}/${{ github.repository }}.git" .
|
||||
- run: npx markdownlint-cli2 "**/*.md"
|
||||
|
||||
link-check:
|
||||
runs-on: linux
|
||||
container: python:3.12-slim
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Check internal links
|
||||
run: |
|
||||
podman run --rm \
|
||||
-v "${{ github.workspace }}:/work:Z" \
|
||||
-w /work \
|
||||
docker.io/library/python:3.12-slim \
|
||||
python3 scripts/check-links.py
|
||||
- run: apt-get update -qq && apt-get install -y -qq git > /dev/null
|
||||
- run: |
|
||||
git clone --depth 1 \
|
||||
-c "http.extraHeader=Authorization: token ${{ github.token }}" \
|
||||
"${{ github.server_url }}/${{ github.repository }}.git" .
|
||||
- run: python3 scripts/check-links.py
|
||||
|
||||
@@ -21,6 +21,12 @@ config:
|
||||
# Allow multiple blank lines
|
||||
MD012: false
|
||||
|
||||
# Allow mixed table column alignment
|
||||
MD060: false
|
||||
|
||||
# Allow lists without surrounding blank lines (tight prose)
|
||||
MD032: false
|
||||
|
||||
globs:
|
||||
- "**/*.md"
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Scattered notes, bookmarks, and `history | grep` are poor substitutes for well-o
|
||||
|
||||
Flat file collection — no build step, no dependencies. Plain Markdown rendered by any viewer (terminal, browser, editor).
|
||||
|
||||
```
|
||||
```text
|
||||
topics/<topic>.md # Individual howto files
|
||||
docs/TEMPLATE.md # Template for new topics
|
||||
```
|
||||
|
||||
@@ -8,7 +8,7 @@ Quick-reference documentation — concise, searchable, copy-pasteable. Each topi
|
||||
|
||||
## Structure
|
||||
|
||||
```
|
||||
```text
|
||||
topics/
|
||||
<topic>.md # One file per subject
|
||||
docs/
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
Each topic file follows `docs/TEMPLATE.md`:
|
||||
|
||||
```
|
||||
```text
|
||||
# <Topic>
|
||||
## Overview — one-liner description
|
||||
## Common Commands — daily-driver commands
|
||||
|
||||
@@ -63,7 +63,7 @@ all:
|
||||
|
||||
## Directory Layout
|
||||
|
||||
```
|
||||
```text
|
||||
inventory/
|
||||
├── hosts.yml # Host definitions
|
||||
├── group_vars/
|
||||
@@ -82,7 +82,7 @@ inventory/
|
||||
|
||||
### Multiple Environments
|
||||
|
||||
```
|
||||
```text
|
||||
inventories/
|
||||
├── staging/
|
||||
│ ├── hosts.yml
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
## Role Directory Structure
|
||||
|
||||
```
|
||||
```text
|
||||
roles/
|
||||
└── nginx/
|
||||
├── defaults/
|
||||
@@ -164,7 +164,7 @@ nginx_access_log: /var/log/nginx/access.log
|
||||
|
||||
## Project Layout with Roles
|
||||
|
||||
```
|
||||
```text
|
||||
ansible-project/
|
||||
├── ansible.cfg
|
||||
├── site.yml # Master playbook
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
Ansible merges variables from many sources. **Higher number wins.**
|
||||
|
||||
```
|
||||
```text
|
||||
1. command line values (for constants, not variables)
|
||||
2. role defaults (roles/x/defaults/main.yml)
|
||||
3. inventory file or script group vars
|
||||
|
||||
@@ -246,7 +246,7 @@ systemctl list-timers
|
||||
|
||||
### OnCalendar Syntax
|
||||
|
||||
```
|
||||
```text
|
||||
# Format: DayOfWeek Year-Month-Day Hour:Minute:Second
|
||||
|
||||
*-*-* 02:00:00 # daily at 2am
|
||||
|
||||
Reference in New Issue
Block a user