Skip to content

faizm10/uog-webring

Repository files navigation

Guelph Webring

A webring for University of Guelph Computer Science students and alumni.

Live site: www.uguelph.network

home page

Join the webring

Option 1: On-site form (no fork needed)

  1. Fill in the Add your site form on the homepage.
  2. Submit once.
  3. The server automatically creates a PR that appends your entry to data/members.json.
  4. If there are no merge conflicts and the Vercel preview check (Vercel) succeeds, it auto-merges to the default branch.

Option 2: Manual PR

  1. Add the widget to your site (template below).
  2. Fork this repo.
  3. Edit data/members.json and add your entry inside sites:
{
  "name": "Your Name",
  "website": "https://your-website.com",
  "year": 20XX,
  "role": "Software Engineer at Company",
  "links": {
    "instagram": "https://instagram.com/your-handle",
    "twitter": "https://x.com/your-handle",
    "linkedin": "https://linkedin.com/in/your-handle"
  }
}
  • role (optional): Your role—e.g. job title, "Student", "Founder", "ML Engineer". Helps others find you when browsing or searching the webring.
  1. Open a pull request.

Widget template

HTML

<div style="display: flex; align-items: center; gap: 8px;">
  <a href="https://www.uguelph.network/#your-site-here?nav=prev"></a>
  <a href="https://www.uguelph.network/#your-site-here" target="_blank" rel="noopener noreferrer">
    <img src="https://www.uguelph.network/webAssets/gryphon.svg" alt="Guelph Webring" style="width: 32px; height: auto; opacity: 0.9;" />
  </a>
  <a href="https://www.uguelph.network/#your-site-here?nav=next"></a>
</div>

JSX

<div style={{ display: "flex", alignItems: "center", gap: "8px" }}>
  <a href="https://www.uguelph.network/#your-site-here?nav=prev"></a>
  <a href="https://www.uguelph.network/#your-site-here" target="_blank" rel="noopener noreferrer">
    <img
      src="https://www.uguelph.network/webAssets/gryphon.svg"
      alt="Guelph Webring"
      style={{ width: "32px", height: "auto", opacity: 0.9 }}
    />
  </a>
  <a href="https://www.uguelph.network/#your-site-here?nav=next"></a>
</div>

The badge uses the gryphon SVG (gryphon.svg).

Notes

  • Keep URLs absolute (https://...).
  • Keep the JSON valid in data/members.json.
  • Optional: Add a role field (e.g. "Software Engineer", "Student", "Founder") so visitors can search and filter by role.
  • Required fields for automation: name, year, website.
  • If you are not in CS, you can still make your own webring for your community.

Deployment config for form auto-PR

To enable automatic PR creation from the on-site form, set these environment variables in your deployment platform:

  • GITHUB_TOKEN: GitHub token with contents:write and pull_requests:write on this repo.

Auto-merge behavior (form submissions only)

  • Only PRs created by the site form flow are eligible for auto-merge.
  • Auto-merge requires:
    • PR is open, non-draft, and mergeable
    • check run named Vercel is completed + success
  • Merge method is squash.
  • Manual PRs are unchanged and remain maintainer-reviewed.

Attribution

This project is forked from: https://cs.uwatering.com/

Original repository: https://github.com/JusGu/uwatering

Used under the MIT License.

About

A webring for uog cs/se students & alumni

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors