Skip to content

Commit d114540

Browse files
committed
better docs on github actions
1 parent 17b216a commit d114540

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

_essay/02-getting-started.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -183,30 +183,44 @@ Essays will appear in navigation based on their `order` value, **not** the filen
183183

184184
## Step 6: Deploy to GitHub Pages
185185

186-
When you're ready to publish:
186+
When you're ready to publish your site:
187187

188-
### Enable GitHub Pages
188+
### Set Up GitHub Pages with Jekyll Action
189189

190-
1. Go to your repository on GitHub
191-
2. Click **Settings** → **Pages**
192-
3. Under **Source**, select **main** branch
193-
4. Click **Save**
190+
CB-Essay requires a GitHub Action to build properly. Follow the complete setup guide:
194191

195-
### Commit Your Changes
192+
**[GitHub Pages Deployment Guide](https://collectionbuilder.github.io/cb-docs/docs/deploy/actions/)**
196193

197-
If you edited on GitHub.com, your changes are already committed! Otherwise:
194+
**Quick summary:**
195+
1. Go to your repository **Settings** → **Pages**
196+
2. Under **Source**, select **GitHub Actions**
197+
3. GitHub will suggest the Jekyll workflow - click **Configure**
198+
4. **Important:** Check the Ruby version in the workflow file
199+
- Look for `ruby-version:` (usually around line 35)
200+
- Change from `3.1` to `3.4` if needed
201+
- CB-Essay requires Ruby 3.4 or higher
202+
5. Commit the workflow file (saves as `.github/workflows/jekyll.yml`)
198203

204+
That's it! Every time you commit changes, GitHub Actions will automatically build and deploy your site.
205+
206+
### Commit Your Changes
207+
208+
- **GitHub.com:** Changes are already committed when you click "Commit changes"
199209
- **GitHub.dev / Codespaces:** Use the Source Control panel to commit and sync
200210
- **Local development:** Run `git add .`, `git commit -m "Add essay"`, `git push`
201211

202-
GitHub Pages will build your site automatically. After a few minutes, visit:
212+
### View Your Live Site
213+
214+
After the GitHub Action completes (usually 2-3 minutes), visit:
203215

204216
```
205217
https://YOUR-USERNAME.github.io/YOUR-REPO-NAME/
206218
```
207219

208220
**Your essay is live!** 🎉
209221

222+
{% include essay/feature/aside.html text="**Tip:** Watch the Actions tab to see the build progress. A green checkmark means your site deployed successfully!" %}
223+
210224
## Common First Steps
211225

212226
### Change Homepage Theme

0 commit comments

Comments
 (0)