Skip to content

Add GitHub Pages deployment guide to CONTRIBUTING.md#461

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
tracygardner merged 1 commit into from
Mar 24, 2026
Merged

Add GitHub Pages deployment guide to CONTRIBUTING.md #461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,6 +71,34 @@ Before starting, we suggest you [get in touch](https://flipcomputing.com/contact
```
7. **Create a Pull Request** on GitHub

### Deploying your fork to GitHub Pages
1. **Push your fork to GitHub**:
```bash
git push origin main
```

2. **Set up GitHub Actions**
- Go to your fork on GitHub at https://github.com/YOUR_USERNAME/flock/
- Click Settings > Pages
- In the 'Source' dropdown, select 'GitHub Actions'

3. **Create the Flock environment**:
- Still in settings, click 'Environments'
- Click 'New Environment'
- Name it `flock` (all lowercase, do not change this)
- Click 'Configure environment' but do not make any changes

4. **Trigger the deployment**
- Go back to your fork at https://github.com/YOUR_USERNAME/flock/
- Click the 'Actions' tab
- Click 'I understand my workflows, go ahead and enable them'
- Click on the new option 'Vite GitHub Pages Deploy'
- Click 'Run workflow' dropdown, then select 'Run workflow' to deploy manually

5. **Visit your deployment**
- Once the site has deployed you will see it at https://YOUR_USERNAME.github.io/flock/
- GitHub pages should redeploy automatically when you push to main

Comment on lines +74 to +101

@coderabbitaicoderabbitaiBotMar 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Resolve the Prettier warning for this file before merge.

The pipeline reported a formatting warning for CONTRIBUTING.md. Please run the formatter and commit the normalized markdown output.

Quick fix command
npx prettier --write CONTRIBUTING.md
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 74 - 101, Prettier reported formatting issues
in CONTRIBUTING.md within the "### Deploying your fork to GitHub Pages" section;
run the formatter (e.g., npx prettier --write CONTRIBUTING.md) to normalize the
markdown, review the formatted changes for any accidental content shifts, and
commit the updated CONTRIBUTING.md so the CI warning is resolved.

For more specific developer-facing documentation, please see [dev-docs.md](dev-docs/dev-docs.md).

## 📁 Project Structure
Expand Down
Loading