ITL Documentation Hub¶

Welcome to the central documentation hub for all ITlusions technical platforms and services. This hub automatically discovers and aggregates documentation from our distributed MkDocs sites.

� Registered Documentation Sites¶

🚀 Quick Start¶

For Documentation Authors¶

1. Deploy your MkDocs site with the ITL Hub integration
2. Register your documentation using our API endpoint
3. Your site will appear automatically in the hub

For Readers¶

1. Browse available documentation in the registry above
2. Click any documentation site to access full content
3. Use the search to find specific topics across all sites

🔗 Registry API¶

Other MkDocs sites can register themselves with this hub using our REST API:

# Register a new documentation site
curl -X POST https://docs.itlusions.com/api/register \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Documentation",
    "description": "Description of the documentation",
    "url": "https://docs.itlusions.com/my-docs/",
    "icon": "material/book",
    "category": "Platform",
    "tags": ["api", "microservices"],
    "version": "1.0.0",
    "health_check": "https://docs.itlusions.com/my-docs/health"
  }'

API Endpoints: - GET /api/sites - List all registered documentation sites - POST /api/register - Register a new documentation site - PUT /api/sites/{id} - Update an existing registration - DELETE /api/sites/{id} - Remove a documentation site

🏗️ Integration Guide¶

To integrate your MkDocs site with this hub, add the following to your deployment pipeline:

GitHub Actions Integration¶

- name: Register with Documentation Hub
  run: |
    curl -X POST https://docs.itlusions.com/api/register \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ${{ secrets.DOCS_HUB_TOKEN }}" \
      -d '{
        "name": "${{ env.SITE_NAME }}",
        "description": "${{ env.SITE_DESCRIPTION }}",
        "url": "${{ env.DEPLOYMENT_URL }}",
        "icon": "${{ env.SITE_ICON }}",
        "category": "${{ env.SITE_CATEGORY }}",
        "version": "${{ github.ref_name }}",
        "repository": "${{ github.repository }}",
        "commit": "${{ github.sha }}"
      }'

Health Checks¶

The hub automatically monitors registered sites for availability. Ensure your site provides a health check endpoint:

# In your mkdocs.yml
nav:
  - Health: health.md

<!-- health.md -->
# Health Check
Status: ✅ Online
Last Updated: {{ timestamp }}

🎯 Categories¶

Documentation sites are automatically organized by category:

• Platform - Core platform services and infrastructure
• Applications - End-user applications and services
• Tools - Development and operational tools
• APIs - API documentation and developer guides
• Operations - Operational procedures and runbooks

📊 Statistics¶