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:
54
README.md
54
README.md
@@ -18,10 +18,20 @@ skeleton/
|
|||||||
│ │ └── security.md
|
│ │ └── security.md
|
||||||
│ └── skills/
|
│ └── skills/
|
||||||
│ └── help/SKILL.md
|
│ └── help/SKILL.md
|
||||||
├── docs/ # Projektdokumentation
|
├── 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/
|
│ ├── doku/
|
||||||
│ └── planung/
|
│ ├── planung/
|
||||||
├── www/ # Subdomains (ein Verzeichnis pro Domain)
|
│ └── todos/
|
||||||
|
├── www/ # Webroot (deployed auf Server)
|
||||||
│ ├── www.example.com/ # www.example.com
|
│ ├── www.example.com/ # www.example.com
|
||||||
│ │ └── public/ # Document Root
|
│ │ └── public/ # Document Root
|
||||||
│ │ └── index.php
|
│ │ └── index.php
|
||||||
@@ -39,26 +49,31 @@ skeleton/
|
|||||||
### Neues Projekt aus Skeleton erstellen
|
### Neues Projekt aus Skeleton erstellen
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 1. Skeleton klonen oder kopieren
|
# 1. Skeleton klonen
|
||||||
git clone https://git.shadow-land.de/madgerm/skeleton.git mein-projekt
|
git clone https://git.shadow-land.de/madgerm/skeleton.git mein-projekt
|
||||||
cd 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/www.example.com www/www.meine-domain.de
|
||||||
mv www/api.example.com www/api.meine-domain.de
|
mv www/api.example.com www/api.meine-domain.de
|
||||||
mv www/app.example.com www/app.meine-domain.de
|
mv www/app.example.com www/app.meine-domain.de
|
||||||
|
|
||||||
# 3. README und Repo-Name anpassen
|
# 3. Docs-Ordner umbenennen (parallel zu www)
|
||||||
# 4. Git init / remote setzen
|
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 init
|
||||||
git remote set-url origin https://git.shadow-land.de/madgerm/mein-projekt.git
|
git remote set-url origin https://git.shadow-land.de/madgerm/mein-projekt.git
|
||||||
|
|
||||||
# 5. Weiter geht's
|
# 6. Weiter geht's
|
||||||
```
|
```
|
||||||
|
|
||||||
### Subdomains deployen
|
### 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:**
|
**Caddy Config Beispiel:**
|
||||||
```
|
```
|
||||||
@@ -69,18 +84,21 @@ www.meine-domain.de {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Subdomains
|
## Domains
|
||||||
|
|
||||||
| Verzeichnis | Domain | Beschreibung |
|
| www/ Verzeichnis | docs/ Verzeichnis | Domain |
|
||||||
|-------------|--------|---------------|
|
|------------------|-------------------|--------|
|
||||||
| `www/www.example.com/` | www.example.com | Hauptseite |
|
| `www/www.example.com/` | `docs/www.example.com/` | www.example.com |
|
||||||
| `www/api.example.com/` | api.example.com | REST API |
|
| `www/api.example.com/` | `docs/api.example.com/` | api.example.com |
|
||||||
| `www/app.example.com/` | app.example.com | Applikation |
|
| `www/app.example.com/` | `docs/app.example.com/` | app.example.com |
|
||||||
|
|
||||||
## Docs
|
## Docs Struktur
|
||||||
|
|
||||||
- `docs/planung/` — Projektplanung, TODOs, Meilensteine
|
Jeder Domain-Ordner enthält:
|
||||||
- `docs/doku/` — Technische Dokumentation
|
|
||||||
|
- `doku/` — Technische Dokumentation (API-Doku, Datenbank-Schema, etc.)
|
||||||
|
- `planung/` — Planung, Meilensteine, Decisions
|
||||||
|
- `todos/` — Aufgaben, TODOs, Issues
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
# Placeholder
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
# Placeholder
|
|
||||||
Reference in New Issue
Block a user