feat: initial itpp-docs setup with MkDocs Material
Publish Docs Site / build (push) Failing after 5s
Publish Docs Site / build (push) Failing after 5s
- mkdocs.yml with dark slate theme, nav for 12 ITPP projects - build-docs.sh aggregates docs from all project repos - .gitea/workflows/docs-publish.yml for nightly rebuild+deploy - README and CHANGELOG for the itpp-docs repo itself - docs-source/ populated from all 12 repos - site/ ready for deployment to docs.itpropartner.com
This commit is contained in:
@@ -1,3 +1,43 @@
|
||||
# itpp-docs
|
||||
# ITPP Docs
|
||||
|
||||
Aggregated MkDocs documentation site for all IT Pro Partner projects
|
||||
> **Owner:** Germaine | **Status:** LIVE
|
||||
> **Last Updated:** 2026-08-09
|
||||
|
||||
Aggregated MkDocs documentation site for all IT Pro Partner projects. Pulls READMEs, CHANGELOGs, and `docs/` directories from every project repo and builds a unified Material-for-MkDocs site served at [docs.itpropartner.com](https://docs.itpropartner.com/).
|
||||
|
||||
## How It Works
|
||||
|
||||
1. `build-docs.sh` clones/fetches every project repo listed in `REPOS`
|
||||
2. Copies each repo's `docs/`, `README.md`, and `CHANGELOG.md` into `docs-source/<project>/`
|
||||
3. `mkdocs build` renders the entire site to `site/`
|
||||
4. Gitea Actions (nightly) or manual rsync deploys to app3
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Site generator:** MkDocs + Material for MkDocs theme
|
||||
- **CI/CD:** Gitea Actions (`.gitea/workflows/docs-publish.yml`)
|
||||
- **Hosting:** Nginx on app3 (152.53.241.111)
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
git clone https://git.itpropartner.com/ippadmin/itpp-docs.git
|
||||
cd itpp-docs
|
||||
pip install mkdocs mkdocs-material
|
||||
bash build-docs.sh
|
||||
mkdocs serve
|
||||
```
|
||||
|
||||
## Deploy
|
||||
|
||||
```bash
|
||||
# Manual deploy
|
||||
bash build-docs.sh && mkdocs build && rsync -avz site/ root@152.53.241.111:/home/ippadmin/htdocs/docs.itpropartner.com/
|
||||
|
||||
# Or push to main — Gitea Actions handles rebuild + deploy nightly
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
- [itpp-infrastructure](https://git.itpropartner.com/ippadmin/itpp-infrastructure) — server inventory, DNS
|
||||
- [itpp-standards](https://git.itpropartner.com/ippadmin/itpp-standards) — docs standards and templates
|
||||
|
||||
Reference in New Issue
Block a user