Skip to content

docs: enhance GitHub Codespaces documentation #1842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 14, 2025
Merged

docs: enhance GitHub Codespaces documentation #1842

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86ee826
docs: enhance GitHub Codespaces documentation
gounthar Nov 14, 2025
f80c0cf
fix: add missing environment key in build-docker-compose.yaml
gounthar Nov 14, 2025
ed690a0
Merge branch 'weekly' into improve-codespaces-docs
gounthar Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,40 @@ This repository includes the files necessary for transitioning from `docker` to

### How to Set Up the Repository in GitHub Codespaces? (Recommended)

GitHub Codespaces provides a cloud-based development environment with Docker pre-installed and configured.

#### Quick Start
1. Click the button below to open this repository in GitHub Codespaces:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jenkins-docs/quickstart-tutorials)

2. Wait for the Codespace to build (first time: ~2-3 minutes, subsequent starts: ~30 seconds)
3. Once ready, the setup script will automatically install required tools
4. Follow the instructions in the terminal to start a tutorial

#### What's Included?
- Docker and Docker Compose pre-installed
- `yq` YAML processor for configuration
- GitHub CLI (`gh`) for repository operations
- Automatic port forwarding for Jenkins (8080) and applications (3000, 5000)
- Jenkins URL automatically configured for Codespaces environment

#### Free Tier
- 60 hours/month for free accounts (sufficient for all tutorials)
- 120 hours/month with [GitHub Student Developer Pack](https://education.github.com/pack)

## Cloud Development Environments

### GitHub Codespaces

GitHub Codespaces is a cloud-based development environment integrated with GitHub. It provides instant, configured development environments with Docker pre-installed, making it perfect for these Jenkins tutorials.

**Benefits:**
- No local installation required
- Consistent environment for all users
- Free tier: 60 hours/month
- Accessible from any device with a browser

**Quick Start:**
1. Click the badge above or the green "Code" button → "Codespaces" tab
2. Click "Create codespace on main"
3. Wait for the environment to initialize (~2-3 minutes)
4. Follow the welcome message in the terminal to start a tutorial
- Automatic backups via GitHub

### Steps to Run Examples from the Repository

Expand Down
Loading