Update documentation with last updated dates and improve navigation indexes
- Added "Last Updated" date to multiple documentation files for better tracking. - Enhanced the README with quick navigation indexes for guides, references, and architecture documentation. - Updated titles in Keycloak deployment and testing guide for consistency.
This commit is contained in:
63
docs/GUIDES_INDEX.md
Normal file
63
docs/GUIDES_INDEX.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# Documentation Guides Index
|
||||
|
||||
**Last Updated**: 2025-01-09
|
||||
|
||||
This index provides quick access to all how-to guides and tutorials in the documentation.
|
||||
|
||||
## Getting Started
|
||||
|
||||
- **[Development Guide](./DEVELOPMENT.md)** - Set up your development environment
|
||||
- **[Quick Start Guides](./smom-dbis-138-QUICK_START.md)** - Quick start instructions
|
||||
- **[Proxmox Quick Start](./proxmox/guides/QUICK_START.md)** - Proxmox setup quick start
|
||||
|
||||
## Deployment Guides
|
||||
|
||||
- **[Deployment Guide](./DEPLOYMENT.md)** - Production deployment instructions
|
||||
- **[Deployment Execution Plan](./DEPLOYMENT_EXECUTION_PLAN.md)** - Step-by-step deployment plan
|
||||
- **[Deployment Requirements](./DEPLOYMENT_REQUIREMENTS.md)** - Complete deployment requirements
|
||||
- **[Pre-Deployment Checklist](./PRE_DEPLOYMENT_CHECKLIST.md)** - Pre-deployment verification
|
||||
- **[VM Creation Procedure](./VM_CREATION_PROCEDURE.md)** - VM creation step-by-step
|
||||
- **[VM Deployment Checklist](./VM_DEPLOYMENT_CHECKLIST.md)** - VM deployment verification
|
||||
- **[Proxmox Deployment Guide](./proxmox/guides/DEPLOYMENT_GUIDE.md)** - Proxmox deployment procedures
|
||||
|
||||
## Configuration Guides
|
||||
|
||||
- **[Configuration Guide](../CONFIGURATION_GUIDE.md)** - General configuration (root level)
|
||||
- **[Environment Variables](../ENV_EXAMPLES.md)** - Environment variable examples
|
||||
- **[DNS Configuration](./proxmox/DNS_CONFIGURATION.md)** - DNS setup for Proxmox
|
||||
- **[TLS Configuration](./proxmox/TLS_CONFIGURATION.md)** - TLS/SSL configuration
|
||||
- **[SSH Setup](./proxmox/SSH_SETUP_WEB_UI.md)** - SSH configuration guides
|
||||
- **[Keycloak Deployment](./KEYCLOAK_DEPLOYMENT.md)** - Keycloak setup and configuration
|
||||
|
||||
## Operational Guides
|
||||
|
||||
- **[Monitoring Guide](./MONITORING_GUIDE.md)** - Monitoring and observability
|
||||
- **[Troubleshooting Guide](./TROUBLESHOOTING_GUIDE.md)** - Comprehensive troubleshooting
|
||||
- **[Operations Runbook](./OPERATIONS_RUNBOOK.md)** - Operational procedures
|
||||
- **[Proxmox Troubleshooting](./proxmox/SSH_TROUBLESHOOTING.md)** - Proxmox-specific troubleshooting
|
||||
|
||||
## Development Guides
|
||||
|
||||
- **[Development Guide](./DEVELOPMENT.md)** - Development setup and workflow
|
||||
- **[Testing Guide](./TESTING.md)** - Testing strategies and examples
|
||||
- **[Contributing Guide](./CONTRIBUTING.md)** - Contribution guidelines
|
||||
- **[Proxmox Development](./proxmox/DEVELOPMENT.md)** - Proxmox development setup
|
||||
|
||||
## Guest Agent & VM Configuration
|
||||
|
||||
- **[Guest Agent Checklist](./GUEST_AGENT_CHECKLIST.md)** - Guest agent configuration
|
||||
- **[Quick Install Guest Agent](./QUICK_INSTALL_GUEST_AGENT.md)** - Quick guest agent setup
|
||||
- **[Enable Guest Agent Manual](./enable-guest-agent-manual.md)** - Manual guest agent setup
|
||||
|
||||
## Infrastructure Guides
|
||||
|
||||
- **[Domain Migration](./infrastructure/DOMAIN_MIGRATION.md)** - Domain migration procedures
|
||||
- **[Cloudflare Domain Setup](./proxmox/CLOUDFLARE_DOMAIN_SETUP.md)** - Cloudflare configuration
|
||||
|
||||
---
|
||||
|
||||
**See Also:**
|
||||
- [Reference Documentation Index](./REFERENCE_INDEX.md) - All reference documentation
|
||||
- [Architecture Documentation Index](./ARCHITECTURE_INDEX.md) - Architecture documentation
|
||||
- [Main Documentation Index](./README.md) - Complete documentation index
|
||||
|
||||
Reference in New Issue
Block a user