feat: Expand documentation structure with comprehensive guides and ex…

…amples
yarlson · Dec 25, 2024 · 3124e58 · 3124e58
1 parent 416ff17
commit 3124e58
Show file tree

Hide file tree

Showing 26 changed files with 444 additions and 26 deletions.
diff --git a/www/astro.config.mjs b/www/astro.config.mjs
@@ -29,13 +29,117 @@ export default defineConfig({
         {
           label: "Guides",
           items: [
-            // Each item here is one entry in the navigation menu.
-            { label: "Example Guide", slug: "guides/example" },
+            { label: "Getting Started", link: "/guides/getting-started/" },
+            { label: "Installation", link: "/guides/installation/" },
+            {
+              label: "Basic Setup",
+              collapsed: true,
+              items: [
+                {
+                  label: "Configuration",
+                  link: "/guides/basic-setup/configuration/",
+                },
+                {
+                  label: "Environment",
+                  link: "/guides/basic-setup/environment/",
+                },
+                {
+                  label: "Dependencies",
+                  link: "/guides/basic-setup/dependencies/",
+                },
+              ],
+            },
+            {
+              label: "Deployment",
+              collapsed: true,
+              items: [
+                { label: "Setup", link: "/guides/deployment/setup/" },
+                {
+                  label: "Deploy Process",
+                  link: "/guides/deployment/deploy-process/",
+                },
+                {
+                  label: "Health Monitoring",
+                  link: "/guides/deployment/health-monitoring/",
+                },
+              ],
+            },
+            {
+              label: "Advanced",
+              collapsed: true,
+              items: [
+                {
+                  label: "Nginx Configuration",
+                  link: "/guides/advanced/nginx/",
+                },
+                { label: "SSL Management", link: "/guides/advanced/ssl/" },
+                {
+                  label: "Zero Downtime Deployment",
+                  link: "/guides/advanced/zero-downtime-deployment/",
+                },
+              ],
+            },
           ],
         },
         {
           label: "Reference",
-          autogenerate: { directory: "reference" },
+          collapsed: true,
+          items: [
+            {
+              label: "CLI",
+              items: [
+                { label: "Commands", link: "/reference/cli/commands/" },
+                {
+                  label: "Configuration",
+                  link: "/reference/cli/configuration/",
+                },
+              ],
+            },
+            {
+              label: "YAML",
+              items: [
+                { label: "Schema", link: "/reference/yaml/schema/" },
+                { label: "Examples", link: "/reference/yaml/examples/" },
+              ],
+            },
+            { label: "Troubleshooting", link: "/reference/troubleshooting/" },
+          ],
+        },
+        {
+          label: "Examples",
+          collapsed: true,
+          items: [
+            {
+              label: "Simple Web App",
+              items: [
+                { label: "Overview", link: "/examples/simple-webapp/" },
+                {
+                  label: "Configuration",
+                  link: "/examples/simple-webapp/configuration/",
+                },
+              ],
+            },
+            {
+              label: "Database Integration",
+              items: [
+                { label: "Overview", link: "/examples/database-integration/" },
+                {
+                  label: "Setup",
+                  link: "/examples/database-integration/setup/",
+                },
+              ],
+            },
+            {
+              label: "Microservices",
+              items: [
+                { label: "Overview", link: "/examples/microservices/" },
+                {
+                  label: "Architecture",
+                  link: "/examples/microservices/architecture/",
+                },
+              ],
+            },
+          ],
         },
       ],
     }),

diff --git a/www/src/components/lander.astro b/www/src/components/lander.astro
@@ -52,7 +52,7 @@ volumes:
           <li>🌐 Multi-provider support</li>
         </ul>
         <div>
-          <a href="/docs/getting-started" class="button">Get Started</a>
+          <a href="/guides/getting-started/" class="button">Get Started</a>
         </div>
       </div>
       <div class="hero-code">

diff --git a/www/src/content/docs/examples/database-integration/index.md b/www/src/content/docs/examples/database-integration/index.md
@@ -0,0 +1,4 @@
+---
+title: index
+description: index
+---
diff --git a/www/src/content/docs/examples/database-integration/setup.md b/www/src/content/docs/examples/database-integration/setup.md
@@ -0,0 +1,4 @@
+---
+title: setup
+description: setup
+---
diff --git a/www/src/content/docs/examples/microservices/architecture.md b/www/src/content/docs/examples/microservices/architecture.md
@@ -0,0 +1,4 @@
+---
+title: architecture
+description: architecture
+---
diff --git a/www/src/content/docs/examples/microservices/index.md b/www/src/content/docs/examples/microservices/index.md
@@ -0,0 +1,4 @@
+---
+title: index
+description: index
+---
diff --git a/www/src/content/docs/examples/simple-webapp/configuration.md b/www/src/content/docs/examples/simple-webapp/configuration.md
@@ -0,0 +1,4 @@
+---
+title: configuration
+description: configuration
+---
diff --git a/www/src/content/docs/examples/simple-webapp/index.md b/www/src/content/docs/examples/simple-webapp/index.md
@@ -0,0 +1,4 @@
+---
+title: index
+description: index
+---
diff --git a/www/src/content/docs/guides/advanced/nginx.md b/www/src/content/docs/guides/advanced/nginx.md
@@ -0,0 +1,4 @@
+---
+title: nginx
+description: nginx
+---
diff --git a/www/src/content/docs/guides/advanced/ssl.md b/www/src/content/docs/guides/advanced/ssl.md
@@ -0,0 +1,4 @@
+---
+title: ssl
+description: ssl
+---
diff --git a/www/src/content/docs/guides/advanced/zero-downtime-deployment.md b/www/src/content/docs/guides/advanced/zero-downtime-deployment.md
@@ -0,0 +1,4 @@
+---
+title: zero downtime deployment
+description: zero downtime deployment
+---
diff --git a/www/src/content/docs/guides/basic-setup/configuration.md b/www/src/content/docs/guides/basic-setup/configuration.md
@@ -0,0 +1,4 @@
+---
+title: configuration
+description: configuration
+---
diff --git a/www/src/content/docs/guides/basic-setup/dependencies.md b/www/src/content/docs/guides/basic-setup/dependencies.md
@@ -0,0 +1,4 @@
+---
+title: dependencies
+description: dependencies
+---
diff --git a/www/src/content/docs/guides/basic-setup/environment.md b/www/src/content/docs/guides/basic-setup/environment.md
@@ -0,0 +1,4 @@
+---
+title: environment
+description: environment
+---
diff --git a/www/src/content/docs/guides/deployment/deploy-process.md b/www/src/content/docs/guides/deployment/deploy-process.md
@@ -0,0 +1,4 @@
+---
+title: deploy process
+description: deploy process
+---
diff --git a/www/src/content/docs/guides/deployment/health-monitoring.md b/www/src/content/docs/guides/deployment/health-monitoring.md
@@ -0,0 +1,4 @@
+---
+title: health monitoring
+description: health monitoring
+---
diff --git a/www/src/content/docs/guides/deployment/setup.md b/www/src/content/docs/guides/deployment/setup.md
@@ -0,0 +1,4 @@
+---
+title: setup
+description: setup
+---
diff --git a/www/src/content/docs/guides/example.md b/www/src/content/docs/guides/example.md
diff --git a/www/src/content/docs/guides/getting-started.md b/www/src/content/docs/guides/getting-started.md
@@ -0,0 +1,68 @@
+---
+title: Getting Started with FTL
+description: Introduction to FTL deployment tool and its key benefits
+---
+
+FTL (Faster Than Light) is a deployment tool designed to simplify application deployment without the complexity of full container orchestration platforms. This guide will help you understand why FTL might be the right choice for your projects.
+
+## Why FTL?
+
+Modern deployment tools often fall into two extremes:
+
+- Heavy orchestration platforms (Kubernetes, ECS) - powerful but complex
+- Basic deployment scripts - simple but limited functionality
+
+FTL fills the gap between these extremes by providing:
+
+- Zero-downtime deployments without complex infrastructure
+- Built-in SSL/TLS certificate management
+- Integrated reverse proxy configuration
+- Multi-provider support
+- Simple YAML configuration
+- No additional infrastructure requirements
+
+## When to Use FTL
+
+FTL is ideal for:
+
+- Small to medium-sized applications
+- Teams wanting simple but robust deployments
+- Projects that don't require complex orchestration
+- Applications with straightforward scaling needs
+- Quick deployment to multiple providers
+
+FTL might not be the best choice if you need:
+
+- Complex micro-service architectures (100s of services)
+- Advanced service mesh features
+- Provider-specific optimizations
+- Custom orchestration requirements
+
+## Deployment Philosophy
+
+FTL follows these core principles:
+
+1. **Simplicity First**
+
+   - Minimal configuration
+   - Sensible defaults
+   - Clear, predictable behavior
+
+2. **Convention Over Configuration**
+
+   - Standard patterns for common scenarios
+   - Reduced decision fatigue
+   - Consistent deployments
+
+3. **Just Enough Automation**
+   - Automate common tasks
+   - Maintain visibility
+   - Keep control when needed
+
+## Next Steps
+
+Ready to get started with FTL? Follow these links to continue:
+
+- [Installation Guide](/guides/installation/) - Install FTL on your system
+- [Configuration Guide](/guides/basic-setup/configuration/) - Learn the basics of FTL configuration
+- [Basic Web App Example](/examples/simple-webapp/) - Deploy your first application