Skip to content

Commit cc96764

Browse files
authored
docs: enhance GitHub Codespaces documentation (#1842)
* docs: enhance GitHub Codespaces documentation Improved the Codespaces section in README to match the comprehensive documentation from main branch. Changes: - Added detailed "What's Included" section listing pre-installed tools - Added "Free Tier" information with Student Developer Pack details - Added new "Cloud Development Environments" section with overview - Enhanced benefits list with automatic backups mention - Improved structure with clearer subsections This provides users with better understanding of what Codespaces offers and helps them get started more quickly. * fix: add missing environment key in build-docker-compose.yaml The CASC_RELOAD_TOKEN environment variable was missing its parent 'environment:' key, causing a YAML parsing error in updatecli. This was likely introduced when GITPOD_WORKSPACE_URL variables were removed, leaving the environment section malformed.
1 parent 0c5f3aa commit cc96764

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

README.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,40 @@ This repository includes the files necessary for transitioning from `docker` to
44

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

7+
GitHub Codespaces provides a cloud-based development environment with Docker pre-installed and configured.
8+
9+
#### Quick Start
10+
1. Click the button below to open this repository in GitHub Codespaces:
11+
712
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jenkins-docs/quickstart-tutorials)
813

14+
2. Wait for the Codespace to build (first time: ~2-3 minutes, subsequent starts: ~30 seconds)
15+
3. Once ready, the setup script will automatically install required tools
16+
4. Follow the instructions in the terminal to start a tutorial
17+
18+
#### What's Included?
19+
- Docker and Docker Compose pre-installed
20+
- `yq` YAML processor for configuration
21+
- GitHub CLI (`gh`) for repository operations
22+
- Automatic port forwarding for Jenkins (8080) and applications (3000, 5000)
23+
- Jenkins URL automatically configured for Codespaces environment
24+
25+
#### Free Tier
26+
- 60 hours/month for free accounts (sufficient for all tutorials)
27+
- 120 hours/month with [GitHub Student Developer Pack](https://education.github.com/pack)
28+
29+
## Cloud Development Environments
30+
31+
### GitHub Codespaces
32+
33+
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.
34+
935
**Benefits:**
1036
- No local installation required
1137
- Consistent environment for all users
1238
- Free tier: 60 hours/month
1339
- Accessible from any device with a browser
14-
15-
**Quick Start:**
16-
1. Click the badge above or the green "Code" button → "Codespaces" tab
17-
2. Click "Create codespace on main"
18-
3. Wait for the environment to initialize (~2-3 minutes)
19-
4. Follow the welcome message in the terminal to start a tutorial
40+
- Automatic backups via GitHub
2041

2142
### Steps to Run Examples from the Repository
2243

0 commit comments

Comments
 (0)