-
Notifications
You must be signed in to change notification settings - Fork 23
Home
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.
- Production: scrumexpansion.org - Live production site
- Preview: agreeable-island-0c966e810-preview.centralus.6.azurestaticapps.net - Test your contributions here before they go live
- -Architecture-Overview Overview
- -Development-Guide Guide
- -Deployment-Guide Guide
- -Configuration-Reference Reference
- Maintainer Guide
- Translation Guide
- -Troubleshooting-Guide
🚨 Important: This project uses Hugo's new template system (v0.146.0+). See the -Development-Guide Guide for details about template structure and migration.
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
- Comprehensive expansion of the Scrum Guide
- Multi-language Translation-Guide
- Downloadable PDF versions
- Creator profiles and attribution
- Structured navigation and table of contents
- 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
- English (default)
- German (Deutsch)
- Spanish (Español)
- French (Français)
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
-
Clone the repository
git clone https://github.com/ScrumGuides/ScrumGuide-ExpansionPack.git cd ScrumGuide-ExpansionPack
-
Install Hugo
# Using package managers choco install hugo-extended # Windows (Chocolatey) brew install hugo # macOS (Homebrew) snap install hugo # Linux (Snap)
-
Run the -Development-Guide server
cd site hugo server -D --bind 0.0.0.0
-
Open your browser Navigate to
http://localhost:1313
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
- GitHub Discussions: Join conversations about the project
- Issues: Report bugs or suggest features
- Pull Requests: Contribute improvements
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.
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.