Reorganize docs/ per domain structure
docs/ now mirrors www/ structure with per-domain subdirectories: - docs/<domain>/doku/ - Technische Dokumentation - docs/<domain>/planung/ - Planung, Meilensteine - docs/<domain>/todos/ - Aufgaben, TODOs www/ contains only public/ (Document Root) - nothing else gets deployed. Readme updated with full structure documentation.
This commit is contained in:
58
README.md
58
README.md
@@ -18,10 +18,20 @@ skeleton/
|
||||
│ │ └── security.md
|
||||
│ └── skills/
|
||||
│ └── help/SKILL.md
|
||||
├── docs/ # Projektdokumentation
|
||||
│ ├── doku/
|
||||
│ └── planung/
|
||||
├── www/ # Subdomains (ein Verzeichnis pro Domain)
|
||||
├── docs/ # Dokumentation pro Domain
|
||||
│ ├── www.example.com/ # Docs für www.example.com
|
||||
│ │ ├── doku/ # Technische Dokumentation
|
||||
│ │ ├── planung/ # Planung, Meilensteine
|
||||
│ │ └── todos/ # Aufgaben, TODOs
|
||||
│ ├── api.example.com/ # Docs für api.example.com
|
||||
│ │ ├── doku/
|
||||
│ │ ├── planung/
|
||||
│ │ └── todos/
|
||||
│ └── app.example.com/ # Docs für app.example.com
|
||||
│ ├── doku/
|
||||
│ ├── planung/
|
||||
│ └── todos/
|
||||
├── www/ # Webroot (deployed auf Server)
|
||||
│ ├── www.example.com/ # www.example.com
|
||||
│ │ └── public/ # Document Root
|
||||
│ │ └── index.php
|
||||
@@ -39,26 +49,31 @@ skeleton/
|
||||
### Neues Projekt aus Skeleton erstellen
|
||||
|
||||
```bash
|
||||
# 1. Skeleton klonen oder kopieren
|
||||
# 1. Skeleton klonen
|
||||
git clone https://git.shadow-land.de/madgerm/skeleton.git mein-projekt
|
||||
cd mein-projekt
|
||||
|
||||
# 2. Domain-Verzeichnisse umbenennen (falls andere Domains gewünscht)
|
||||
# 2. Domain-Verzeichnisse umbenennen
|
||||
mv www/www.example.com www/www.meine-domain.de
|
||||
mv www/api.example.com www/api.meine-domain.de
|
||||
mv www/app.example.com www/app.meine-domain.de
|
||||
|
||||
# 3. README und Repo-Name anpassen
|
||||
# 4. Git init / remote setzen
|
||||
# 3. Docs-Ordner umbenennen (parallel zu www)
|
||||
mv docs/www.example.com docs/www.meine-domain.de
|
||||
mv docs/api.example.com docs/api.meine-domain.de
|
||||
mv docs/app.example.com docs/app.meine-domain.de
|
||||
|
||||
# 4. README und Repo-Name anpassen
|
||||
# 5. Git init / remote setzen
|
||||
git init
|
||||
git remote set-url origin https://git.shadow-land.de/madgerm/mein-projekt.git
|
||||
|
||||
# 5. Weiter geht's
|
||||
# 6. Weiter geht's
|
||||
```
|
||||
|
||||
### Subdomains deployen
|
||||
|
||||
Jedes `www/<subdomain>/public/` Verzeichnis ist der Document-Root für die jeweilige Subdomain.
|
||||
Jedes `www/<domain>/public/` Verzeichnis ist der Document Root für die jeweilige Domain.
|
||||
|
||||
**Caddy Config Beispiel:**
|
||||
```
|
||||
@@ -69,18 +84,21 @@ www.meine-domain.de {
|
||||
}
|
||||
```
|
||||
|
||||
## Subdomains
|
||||
## Domains
|
||||
|
||||
| Verzeichnis | Domain | Beschreibung |
|
||||
|-------------|--------|---------------|
|
||||
| `www/www.example.com/` | www.example.com | Hauptseite |
|
||||
| `www/api.example.com/` | api.example.com | REST API |
|
||||
| `www/app.example.com/` | app.example.com | Applikation |
|
||||
| www/ Verzeichnis | docs/ Verzeichnis | Domain |
|
||||
|------------------|-------------------|--------|
|
||||
| `www/www.example.com/` | `docs/www.example.com/` | www.example.com |
|
||||
| `www/api.example.com/` | `docs/api.example.com/` | api.example.com |
|
||||
| `www/app.example.com/` | `docs/app.example.com/` | app.example.com |
|
||||
|
||||
## Docs
|
||||
## Docs Struktur
|
||||
|
||||
- `docs/planung/` — Projektplanung, TODOs, Meilensteine
|
||||
- `docs/doku/` — Technische Dokumentation
|
||||
Jeder Domain-Ordner enthält:
|
||||
|
||||
- `doku/` — Technische Dokumentation (API-Doku, Datenbank-Schema, etc.)
|
||||
- `planung/` — Planung, Meilensteine, Decisions
|
||||
- `todos/` — Aufgaben, TODOs, Issues
|
||||
|
||||
## Tech Stack
|
||||
|
||||
@@ -88,4 +106,4 @@ Skeleton ist flexibel — standardmäßig PHP mit SQLite, anpassbar je nach Proj
|
||||
|
||||
## Lizenz
|
||||
|
||||
Projektintern — keine externe Lizenz.
|
||||
Projektintern — keine externe Lizenz.
|
||||
Reference in New Issue
Block a user