Skip to content

Commit e53bb2d

Browse files
authored
Add configuration and deployment guides to docs (#9591)
1 parent d079ac7 commit e53bb2d

File tree

5 files changed

+1875
-6
lines changed

5 files changed

+1875
-6
lines changed

docs/README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ Complete guide to all ProxmoxVE documentation - quickly find what you need.
2222
→ See also: [misc/error_handler.func/](misc/error_handler.func/)
2323

2424
**Configure system defaults**
25-
→ Read: [DEFAULTS_SYSTEM_GUIDE.md](DEFAULTS_SYSTEM_GUIDE.md)
25+
→ Read: [guides/DEFAULTS_SYSTEM_GUIDE.md](guides/DEFAULTS_SYSTEM_GUIDE.md)
26+
27+
**Deploy containers automatically**
28+
→ Read: [guides/UNATTENDED_DEPLOYMENTS.md](guides/UNATTENDED_DEPLOYMENTS.md)
2629

2730
**Develop a function library**
2831
→ Study: [misc/](misc/) documentation
@@ -61,7 +64,8 @@ Complete guide to all ProxmoxVE documentation - quickly find what you need.
6164

6265
**System Operator**
6366
→ Start: [EXIT_CODES.md](EXIT_CODES.md)
64-
→ Then: [DEFAULTS_SYSTEM_GUIDE.md](DEFAULTS_SYSTEM_GUIDE.md)
67+
→ Then: [guides/DEFAULTS_SYSTEM_GUIDE.md](guides/DEFAULTS_SYSTEM_GUIDE.md)
68+
→ Automate: [guides/UNATTENDED_DEPLOYMENTS.md](guides/UNATTENDED_DEPLOYMENTS.md)
6569
→ Debug: [DEV_MODE.md](DEV_MODE.md)
6670

6771
**Architect**
@@ -83,7 +87,8 @@ ProxmoxVE/
8387
├─ vm/ ↔ docs/vm/ (README.md)
8488
├─ tools/ ↔ docs/tools/ (README.md)
8589
├─ api/ ↔ docs/api/ (README.md)
86-
└─ misc/ ↔ docs/misc/ (9 function libraries)
90+
├─ misc/ ↔ docs/misc/ (9 function libraries)
91+
└─ [system-wide] ↔ docs/guides/ (configuration & deployment guides)
8792
```
8893

8994
### Core Documentation
@@ -94,7 +99,9 @@ ProxmoxVE/
9499
| [ct/DETAILED_GUIDE.md](ct/DETAILED_GUIDE.md) | Create ct scripts | Container developers |
95100
| [install/DETAILED_GUIDE.md](install/DETAILED_GUIDE.md) | Create install scripts | Installation developers |
96101
| [TECHNICAL_REFERENCE.md](TECHNICAL_REFERENCE.md) | Architecture deep-dive | Architects, advanced users |
97-
| [DEFAULTS_SYSTEM_GUIDE.md](DEFAULTS_SYSTEM_GUIDE.md) | Configuration system | Operators, power users |
102+
| [guides/DEFAULTS_SYSTEM_GUIDE.md](guides/DEFAULTS_SYSTEM_GUIDE.md) | Configuration system | Operators, power users |
103+
| [guides/CONFIGURATION_REFERENCE.md](guides/CONFIGURATION_REFERENCE.md) | Configuration options reference | Advanced users |
104+
| [guides/UNATTENDED_DEPLOYMENTS.md](guides/UNATTENDED_DEPLOYMENTS.md) | Automated deployments | DevOps, automation |
98105
| [EXIT_CODES.md](EXIT_CODES.md) | Exit code reference | Troubleshooters |
99106
| [DEV_MODE.md](DEV_MODE.md) | Debugging tools | Developers |
100107

@@ -190,7 +197,7 @@ Documentation for `/misc` - 9 core function libraries with complete references.
190197

191198
1. All of Intermediate Path
192199
2. Study all 9 function libraries in depth
193-
3. [DEFAULTS_SYSTEM_GUIDE.md](DEFAULTS_SYSTEM_GUIDE.md) - Configuration system
200+
3. [guides/DEFAULTS_SYSTEM_GUIDE.md](guides/DEFAULTS_SYSTEM_GUIDE.md) - Configuration system
194201
4. [DEV_MODE.md](DEV_MODE.md) - Debugging and development
195202
5. Design new features or function libraries
196203

@@ -234,7 +241,8 @@ Documentation for `/misc` - 9 core function libraries with complete references.
234241

235242
### By Role
236243
- **Contributor**[contribution/README.md](contribution/README.md)
237-
- **Operator**[DEFAULTS_SYSTEM_GUIDE.md](DEFAULTS_SYSTEM_GUIDE.md)
244+
- **Operator**[guides/DEFAULTS_SYSTEM_GUIDE.md](guides/DEFAULTS_SYSTEM_GUIDE.md)
245+
- **Automation**[guides/UNATTENDED_DEPLOYMENTS.md](guides/UNATTENDED_DEPLOYMENTS.md)
238246
- **Developer**[TECHNICAL_REFERENCE.md](TECHNICAL_REFERENCE.md)
239247
- **Architect**[misc/README.md](misc/README.md)
240248

0 commit comments

Comments
 (0)