README: Live-URL, Deploy-Ablauf und Struktur aktualisieren
Deploy tibi-docs / build-and-deploy (push) Successful in 22s
Deploy tibi-docs / build-and-deploy (push) Successful in 22s
This commit is contained in:
1 parent
40bfb521aa
commit
fc0bb28308
1 file changed
+34
-9
@@ -1,9 +1,9 @@
|
|||||||
# Tibi Doku
|
# Tibi Doku
|
||||||
|
|
||||||
Entwickler- und später Anwender-Dokumentation für **Tibi-Server** und **Tibi-Admin-Nova**.
|
Entwickler- und Anwender-Dokumentation für **Tibi-Server** und **Tibi-Admin** (Release Nova).
|
||||||
Basis: [Astro Starlight](https://starlight.astro.build/) — Markdown-Quellen, statischer Build, eingebaute Volltextsuche (Pagefind). Theme an Nova angelehnt (Inter, Near-Black, Nova-Orange).
|
Basis: [Astro Starlight](https://starlight.astro.build/) — Markdown-Quellen, statischer Build, eingebaute Volltextsuche (Pagefind, läuft komplett im Browser). Theme an Nova angelehnt (Inter, Near-Black, Nova-Orange).
|
||||||
|
|
||||||
Altes Demo+Docs-Repo liegt archiviert unter `cms/tibi-docs-legacy`.
|
**Live:** https://docs.tibicms.de — ersetzt die alte Docpress-Doku (`cms/tibi-docs-legacy`, archiviert).
|
||||||
|
|
||||||
## Start
|
## Start
|
||||||
|
|
||||||
@@ -20,23 +20,48 @@ make docker-down
|
|||||||
Single Source bleibt in den Quell-Repos — hier wird nur gerendert:
|
Single Source bleibt in den Quell-Repos — hier wird nur gerendert:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm run sync # tibi-server/docs + tibi-admin-nova/docs übernehmen
|
|
||||||
npm run sync:openapi # OpenAPI vom laufenden Server holen (TIBI_API_URL)
|
npm run sync:openapi # OpenAPI vom laufenden Server holen (TIBI_API_URL)
|
||||||
|
npm run gen:schemas # reference/schema-properties.md aus tibi-types erzeugen
|
||||||
npm run build # prüfen, ob alles rendert
|
npm run build # prüfen, ob alles rendert
|
||||||
|
node scripts/audit-docs.mjs # Frontmatter, Links, Anker, Bilder, Tabellen (nach dem Build)
|
||||||
```
|
```
|
||||||
|
|
||||||
Eigene Seiten: `src/content/docs/{einstieg,nova,anwender,reference,adr}/`.
|
Eigene Seiten: `src/content/docs/{einstieg,projekt,server,admin,anwender,reference,adr}/`.
|
||||||
|
|
||||||
|
## Deploy
|
||||||
|
|
||||||
|
Push auf `master` löst `.gitea/workflows/deploy.yml` aus:
|
||||||
|
|
||||||
|
1. `npm ci` und `npm run build` (statischer Build nach `dist/`).
|
||||||
|
2. Sanity-Check: `dist/index.html`, `dist/404.html`, `dist/pagefind/` müssen existieren.
|
||||||
|
3. `rsync ./dist/` mit `--delete` auf `ftp1.webmakers.de:22223`.
|
||||||
|
|
||||||
|
Auth läuft über den Repo-Token (`github.token`), nicht über Passwörter. Die Basispanel-Subdomain
|
||||||
|
`docs.tibicms.de` (ID 2216, dock4) trägt `gitbaseRepository=cms/tibi-docs` und `deployRoot=./`;
|
||||||
|
das rsync-Chroot ist der Docroot der Subdomain, deshalb ist `./` direkt das Webroot.
|
||||||
|
HTTPS kommt per certbot, HTTP wird auf HTTPS umgeleitet.
|
||||||
|
|
||||||
|
Zum Vergleich: Projekt-Websites aus `tibi-svelte-starter` deployen `frontend/` und `api/` auf
|
||||||
|
dieselbe Art (siehe `projekt/deploy` in der Doku).
|
||||||
|
|
||||||
## Struktur
|
## Struktur
|
||||||
|
|
||||||
```text
|
```text
|
||||||
src/content/docs/
|
src/content/docs/
|
||||||
index.mdx Startseite (Hero)
|
index.mdx Startseite (Hero)
|
||||||
einstieg/ was-ist-tibi, schnellstart, begriffe
|
einstieg/ was-ist-tibi, schnellstart, begriffe, neues-projekt
|
||||||
# Neuaufbau: server/, nova/, anwender/, reference/, adr/ folgen
|
projekt/ Sammlungen, Hooks, SSR, Suche, Deploy …
|
||||||
|
server/ Konfiguration, Betrieb, Sicherheit, Schnittstellen
|
||||||
|
admin/ Bedienoberfläche tibi-admin
|
||||||
|
anwender/ Redakteurs-Anleitungen
|
||||||
|
reference/ OpenAPI, Schemas, Hook-Kontexte (teils generiert)
|
||||||
|
adr/ Architektur-Entscheide
|
||||||
scripts/
|
scripts/
|
||||||
sync-server-docs.mjs
|
audit-docs.mjs Prüfung von Quellen und gebautem dist/
|
||||||
sync-openapi.mjs
|
coverage-inventory.mjs Coverage-Inventar (Routen, Kontexte, Tools, Schemas)
|
||||||
|
gen-schema-matrix.mjs Schema-Properties generieren
|
||||||
|
sync-openapi.mjs OpenAPI vom laufenden Server holen
|
||||||
|
plans/ Audit-, Ausbau- und Screenshot-Pläne
|
||||||
```
|
```
|
||||||
|
|
||||||
Siehe `AGENTS.md` für die Agenten-Regeln.
|
Siehe `AGENTS.md` für die Agenten-Regeln.
|
||||||
Reference in new issue
Block a user