Skip to content

Add website events guide #4

Open
@MathyouMB

Description

@MathyouMB

As a volunteer or exec, I want a clear guide on how to add events to the CCSS website so that I can promote upcoming events without needing to ask for help or dig through the repo.


🧠 Context

We currently don’t have a documented guide on how to add events to the CCSS website. Contributors are expected to know how the CarletonComputerScienceSociety/website repo works and where to place files, which creates unnecessary friction.

We should publish a page at:

https://handbook.carletoncomputersciencesociety.ca/docs/guides/website/add-events

This page should provide a step-by-step guide with code examples showing:

  • How to add a new event to the website
  • Where to put the markdown file
  • Where to upload the event poster

🛠️ Implementation Plan

  1. Create a new page at:
    docs/guides/website/add-events.md

  2. Write a guide on this page:

    • A short intro sentence explaining that this guide helps you add an event to the CCSS website

    • Step 1: Create an event markdown file

      • Go to content/events

      • Add a new file named something like 2024-09-10-frosh-social.md

      • Include an example frontmatter and body content:

        ---
        title: "Frosh Social"
        date: 2024-09-10
        time: "6:00 PM"
        location: "Canal Ritz"
        preview: "images/event_posters/2024/frosh-social.jpg"
        ---
        Come meet your fellow first-years and have fun at our first social event of the year!
    • Step 2: Add your event poster

    • Step 3: Commit your changes

      • Include both the markdown file and the image in your PR
      • Example commit message:
        Add Frosh Social event for Sept 10
  3. Ensure the page has proper formatting


✅ Acceptance Criteria

  • A new page exists at docs/guides/website/add-events.md

  • The guide includes:

    • A clear explanation of where to add the event markdown file
    • An example frontmatter block and markdown body
    • Instructions for uploading the poster image
    • A sample commit message
  • All links point to the correct GitHub repo paths

  • The page is properly formatted and appears in the sidebar under "Guides > Website"

Metadata

Metadata

Labels

Type

No type

Projects

Status

For Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions