Initial: ITPP standards repo with templates, CI workflows, .gitignore, and .markdownlint.json

2026-08-09 23:38:14 -04:00
commit 493172dc90
11 changed files with 250 additions and 0 deletions
@@ -0,0 +1,39 @@
+# ITPP Standards
+
+> **Owner:** Germaine | **Status:** LIVE
+> **Last Updated:** 2026-08-09
+
+Canonical documentation standards, templates, and CI workflows for all IT Pro Partner repositories. Use this repo as a Gitea template when creating new projects, or copy individual templates as needed.
+
+## What's Inside
+
+- `templates/` — README, CHANGELOG, DESIGN.md, and MkDocs config templates for new projects
+- `templates/gitea-ci/` — Reusable Gitea Actions workflows (docs lint, link check, spell check)
+- `.markdownlint.json` — Standard Markdown linting rules for all ITPP repos
+- `.gitignore` — Canonical `.gitignore` for Python, Node.js, secrets, and build artifacts
+
+## Quick Start
+
+```bash
+# Option 1: Use as Gitea template
+# In Gitea UI: New Repository → From Template: itpp-standards
+
+# Option 2: Copy templates into existing repo
+git clone https://git.itpropartner.com/ippadmin/<your-repo>.git
+cp /path/to/itpp-standards/templates/repo-readme.md <your-repo>/README.md
+cp /path/to/itpp-standards/templates/repo-changelog.md <your-repo>/CHANGELOG.md
+cp /path/to/itpp-standards/.gitignore <your-repo>/
+cp /path/to/itpp-standards/templates/gitea-ci/docs-check.yml <your-repo>/.gitea/workflows/
+```
+
+## Standards
+
+- **README.md** — Mandatory. Every repo must have one. Minimum 400 bytes. Follow the template.
+- **CHANGELOG.md** — Mandatory. Reverse-chronological, user-facing, one line per change.
+- **DESIGN.md** — When the project has a public API or multiple consumers.
+- **.gitea/workflows/docs-check.yml** — Recommended. Lints Markdown and checks links on push.
+
+## Related
+
+- [itpp-infrastructure](https://git.itpropartner.com/ippadmin/itpp-infrastructure) — server inventory, DNS
+- [itpp-docs](https://git.itpropartner.com/ippadmin/itpp-docs) — aggregated docs site