Home - ScrumGuides/ScrumGuide-ExpansionPack GitHub Wiki

Scrum Guide Expansion Pack Documentation

Welcome to the documentation for the Scrum Guide Expansion Pack project. This documentation provides comprehensive information about the project structure, -Development-Guide workflow, and contribution guidelines.

🌐 Live Sites

Quick Navigation

Technical Documentation

Project Overview

The Scrum Guide Expansion Pack is a multilingual static website built with Hugo that provides an expanded interpretation of the official 2020 Scrum Guide. The project includes:

  • Multi-language support (English, German, Spanish, French)
  • Modern responsive design with Bootstrap 5
  • Static site generation with Hugo
  • Automated -Deployment-Guide via Azure Static Web Apps
  • PDF generation capabilities
  • Community contribution features

Key Features

πŸ“š Content Features

  • Comprehensive expansion of the Scrum Guide
  • Multi-language Translation-Guide
  • Downloadable PDF versions
  • Creator profiles and attribution
  • Structured navigation and table of contents

πŸ”§ Technical Features

  • Hugo static site generator
  • Bootstrap 5 responsive design
  • Font Awesome icons
  • Google Analytics integration
  • Azure Static Web Apps hosting
  • GitHub Actions for CI/CD
  • Environment-specific -Configuration-References

🌍 Internationalization

  • English (default)
  • German (Deutsch)
  • Spanish (EspaΓ±ol)
  • French (FranΓ§ais)

Project Structure

ScrumGuide-ExpansionPack/
β”œβ”€β”€ docs/                           # πŸ“š Documentation
β”œβ”€β”€ site/                           # πŸ—οΈ Hugo site source
β”‚   β”œβ”€β”€ content/                    # πŸ“ Content files
β”‚   β”œβ”€β”€ layouts/                    # 🎨 HTML templates
β”‚   β”œβ”€β”€ static/                     # πŸ“ Static assets
β”‚   β”œβ”€β”€ data/                       # πŸ—ƒοΈ Data files
β”‚   β”œβ”€β”€ i18n/                       # 🌐 Translation-Guide
β”‚   └── hugo.yaml                   # βš™οΈ Hugo -Configuration-Reference
β”œβ”€β”€ public/                         # πŸš€ Generated site output
β”œβ”€β”€ .github/                        # πŸ”„ GitHub Actions workflows
β”œβ”€β”€ staticwebapp.config.*.json      # βš™οΈ Azure SWA configs
└── readme.md                       # πŸ“– Project README

Quick Start

  1. Clone the repository

    git clone https://github.com/ScrumGuides/ScrumGuide-ExpansionPack.git
cd ScrumGuide-ExpansionPack

  2. Install Hugo

    # Using package managers
choco install hugo-extended  # Windows (Chocolatey)
brew install hugo            # macOS (Homebrew)
snap install hugo           # Linux (Snap)

  3. Run the -Development-Guide server

    cd site
hugo server -D --bind 0.0.0.0

  4. Open your browser Navigate to http://localhost:1313

-Contributing-to-the-Scrum-Guide-Expansion-Pack

We welcome contributions from the community! Please see our -Contributing-to-the-Scrum-Guide-Expansion-Pack Guidelines for detailed information on:

  • Setting up your -Development-Guide environment
  • Content contribution process
  • Translation guidelines
  • Code contribution standards
  • Pull request process

Support and Community

  • GitHub Discussions: Join conversations about the project
  • Issues: Report bugs or suggest features
  • Pull Requests: Contribute improvements

License

This project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license. See the LICENSE file for details.

Authors and Attribution

The Scrum Guide Expansion Pack is created by:

  • Ralph Jocham
  • John Coleman
  • Jeff Sutherland

Based on the original 2020 Scrum Guide by Ken Schwaber and Jeff Sutherland.

πŸ“š Next Steps: Start with the Getting Started Guide to set up your -Development-Guide environment.