|
| 1 | +# 🚀 GitHub Pages Setup Guide for kdebug |
| 2 | + |
| 3 | +## Step 1: Enable GitHub Pages |
| 4 | + |
| 5 | +1. **Go to your repository**: https://github.com/timkrebs/kdebug |
| 6 | +2. **Click on "Settings"** (in the repository top navigation) |
| 7 | +3. **Scroll down to "Pages"** (in the left sidebar under "Code and automation") |
| 8 | +4. **Under "Source"**, select **"GitHub Actions"** (this enables the workflow we created) |
| 9 | +5. **Click "Save"** |
| 10 | + |
| 11 | +## Step 2: Wait for Deployment |
| 12 | + |
| 13 | +The GitHub Actions workflow will automatically: |
| 14 | +- Build the Jekyll site |
| 15 | +- Deploy it to GitHub Pages |
| 16 | +- Make it available at: **https://timkrebs.github.io/kdebug/** |
| 17 | + |
| 18 | +You can monitor the deployment progress in the "Actions" tab of your repository. |
| 19 | + |
| 20 | +## Step 3: Update Configuration (Optional) |
| 21 | + |
| 22 | +To customize the site for your repository, update `_config.yml`: |
| 23 | + |
| 24 | +```yaml |
| 25 | +# Update these values in _config.yml |
| 26 | +github_username: timkrebs |
| 27 | +github_repo: kdebug |
| 28 | +url: "https://timkrebs.github.io" |
| 29 | +``` |
| 30 | +
|
| 31 | +## Step 4: Verify Deployment |
| 32 | +
|
| 33 | +Once the GitHub Actions workflow completes (usually 2-3 minutes), your website will be live at: |
| 34 | +
|
| 35 | +**🌐 https://timkrebs.github.io/kdebug/** |
| 36 | +
|
| 37 | +## What's Included |
| 38 | +
|
| 39 | +Your website includes: |
| 40 | +
|
| 41 | +### 📖 **Comprehensive Documentation** |
| 42 | +- **Getting Started** - Quick installation and usage guide |
| 43 | +- **Installation** - Detailed setup instructions for all platforms |
| 44 | +- **Commands Reference** - Complete command documentation with examples |
| 45 | +- **Examples** - Real-world troubleshooting scenarios |
| 46 | +- **Contributing** - Developer guide and contribution workflow |
| 47 | +
|
| 48 | +### 🎨 **Professional Design** |
| 49 | +- **Kubernetes-inspired styling** - Professional blue color scheme |
| 50 | +- **Responsive design** - Works perfectly on mobile, tablet, and desktop |
| 51 | +- **Card-based layouts** - Clean, modern interface |
| 52 | +- **Fast loading** - Optimized for performance |
| 53 | +
|
| 54 | +### 🔧 **Developer Features** |
| 55 | +- **Search engine optimization** - Great discoverability |
| 56 | +- **Mobile-first design** - Excellent mobile experience |
| 57 | +- **Accessible navigation** - Keyboard and screen reader friendly |
| 58 | +- **Live reload during development** - `make website-serve` |
| 59 | + |
| 60 | +## Development Workflow |
| 61 | + |
| 62 | +To work on the website locally: |
| 63 | + |
| 64 | +```bash |
| 65 | +# Install dependencies (one-time setup) |
| 66 | +make website-deps |
| 67 | +
|
| 68 | +# Start development server |
| 69 | +make website-serve |
| 70 | +
|
| 71 | +# Visit: http://localhost:4000 |
| 72 | +``` |
| 73 | + |
| 74 | +## Automatic Updates |
| 75 | + |
| 76 | +The website will automatically rebuild and deploy whenever you: |
| 77 | +- Push changes to the main branch |
| 78 | +- Update any website files (`_*`, `assets/`, `index.md`, etc.) |
| 79 | + |
| 80 | +## Next Steps |
| 81 | + |
| 82 | +1. **Enable GitHub Pages** using the steps above |
| 83 | +2. **Wait for deployment** (check Actions tab for progress) |
| 84 | +3. **Visit your live site**: https://timkrebs.github.io/kdebug/ |
| 85 | +4. **Share with the community** - Your kdebug project now has professional documentation! |
| 86 | + |
| 87 | +## Support |
| 88 | + |
| 89 | +If you encounter any issues: |
| 90 | +- Check the GitHub Actions logs in the "Actions" tab |
| 91 | +- Review the website development guide in `docs/website.md` |
| 92 | +- Ensure Ruby and Jekyll are properly installed for local development |
| 93 | + |
| 94 | +--- |
| 95 | + |
| 96 | +🎉 **Congratulations!** Your kdebug project now has a professional documentation website that will help users discover, install, and contribute to your project! |
0 commit comments