Summary of proposed structure, and current structure

Summary of proposed structure, and current structure

Hyku Documentation Structure Summary [NEW]

For the Market Segment (Confluence)

  1. Hyku Overview and Core Concepts

  2. Features and Capabilities (including Accessibility Compliance)

  3. Comparison Guides (Hyku vs. Other Solutions, PostgreSQL vs. Fedora)

  4. Case Studies of Real-World Implementations

  5. Implementation Planning Resources

  6. Roadmap and Future Development Plans

For Repository Administrators (Confluence)

  1. Administrative Dashboard Guide

  2. Multi-Tenancy Management

  3. User Management

  4. Collection Management

  5. Workflow Configuration

  6. Theming and Branding

  7. Analytics and Reporting

  8. Content Display Configuration

    • Viewer Technologies (PDF.js vs. Universal Viewer)

    • IIIF Implementation

    • Accessibility Settings

For Content Managers (Confluence)

  1. Metadata Management Best Practices

  2. Bulk Import/Export Using Bulkrax

  3. Work Type Selection Guidelines

  4. Collection Organization Strategies

For Repository Contributors (Confluence)

  1. Content Submission Guides by Work Type

  2. Metadata Entry Guidelines

  3. File Format Recommendations

For Developers (GitHub)

  1. Installation

    • Environment Setup

    • Production Installation

    • Development Installation

    • Docker Configuration

  2. Configuration

    • Initial Configuration

    • Storage Options

    • Authentication Integration

    • Search Configuration

  3. Customization

    • Hyku Knapsack

    • Creating Custom Work Types

    • Metadata Customization

    • UI/UX Customization

  4. APIs and Integration

    • API Reference

    • External System Integration (Avalon, Archivematica)

    • OAI-PMH Configuration

  5. Performance and Scaling

  6. Migration Tools and Strategies

  7. Contributing to Hyku

Cross-Cutting Resources (Both Platforms)

  1. Glossary

  2. FAQ by User Segment

  3. Troubleshooting Guides

  4. Community Resources

  5. Version Information

    • Version History

    • Upgrade Guides

    • Feature Preview (v6.2 Flexible Metadata, GA4, Rails 7.x)

 

Current Structure