Skip to content

Commit

Permalink
feat: ✨ centralized calendar external docs
Browse files Browse the repository at this point in the history
Co-authored-by: Jose Gonzalez <[email protected]>
  • Loading branch information
alexanderl19 and josegonz115 committed Oct 4, 2024
1 parent 3de7e3d commit 1daf0a6
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 1 deletion.
108 changes: 108 additions & 0 deletions content/docs/developer/centralized-calendar/ics-club-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
title: ICS Club Guide
---

import { Callout } from "fumadocs-ui/components/callout";
import { Step, Steps } from "fumadocs-ui/components/steps";
import { Accordion, Accordions } from "fumadocs-ui/components/accordion";

<Callout>
This page is intended for members of other ICS organizations to guide them
through the process of participating in the ics-centralized-calendar project.
</Callout>

## Introduction

The Centralized Calendar project aims to bring the ICS community closer by making affiliated events easier to discover, and allowing ICSSC to better promote all events. Within ICSSC, this will power our centralized calendar on [studentcouncil.ics.uci.edu](https://studentcouncil.ics.uci.edu), our weekly calendar, weekly newsletter, and Wednesday event shoutouts.

## Steps to Add Your Events

All that's required for the ics-centralized-calendar project is a Google Calendar with your events. Follow these steps to find and share your Google Calendar URL:

Alternatively, internal/board members of ICS Affiliated Clubs can email [[email protected]](mailto:[email protected]) to schedule a short meeting to walk through the process.

<Steps>
<Step>
### Find Your Calendar

1. Go to [Google Calendar](https://calendar.google.com).
2. Open your settings by clicking on the gear icon in the top bar and select "Settings".
3. Find your calendar in the sidebar and click on it.

</Step>
<Step>
### Ensure Public Access

1. Scroll down to the "Access permissions for events" section.
2. Ensure that "Make available to public" is checked and set to "See all event details"

</Step>
<Step>

### Get the Shareable Link

1. Scroll further down to the "Integrate calendar" section.
2. Copy the "Public address in iCal format" link.

<Callout>This URL should end in `.ics`.</Callout>

</Step>
<Step>

### Submit Your Calendar Link

Send the copied calendar link to your ICSSC contact or our EVP.

</Step>
</Steps>

{/* Include a breif FAQ with information on how event updates work. */}

## FAQ

<Accordions>
<Accordion title="How do event updates work?">
Once your calendar link is submitted and integrated into the
ics-centralized-calendar, your events will be automatically updated every
15 minutes. This ensures that any new events or changes to existing events that
have not happened yet are reflected in the ics-centralized-calendar quickly.
</Accordion>
<Accordion title="What event information is required?">

Every event should have the following fields for best clarity and organization, these fields are usually required by default when creating an event in Google Calendar:

- **Title:** A clear description of the event.
- **Location:** The location of the event, or a virtual meeting link in the location field of the event.
- **Date and Time:** A start and end time that is input through the Google Calendar GUI.
- **Description:** Include details such as location, agenda, and contact information.

</Accordion>
<Accordion title="How can I make changes to my events?">

Simply update your events in your Google Calendar. The changes will be reflected in during the next update cycle.

</Accordion>
<Accordion title="How do I change my club's calendar from the centralized calendar?">

Contact our EVP or have a board member email [[email protected]](mailto:[email protected]) to change your calendar URL.

</Accordion>
<Accordion title="How do I remove my club's calendar from the centralized calendar?">

While we encourage all ICS clubs to participate, email [[email protected]](mailto:[email protected]) if you wish to remove your club's events. After removal, your events will no longer be announced on our weekly calendars or regularly publicized at our events.

</Accordion>
<Accordion title="Who do I contact for support?">

If you have any questions or need assistance, contact our EVP, or email [[email protected]](mailto:[email protected]).

</Accordion>
<Accordion title="Can I use an alternative calendar service?">

Yes, email [[email protected]](mailto:[email protected]).

</Accordion>
</Accordions>

By participating in the ics-centralized-calendar project, you help create a
more organized and informed ICS community. Thank you for your contribution!
12 changes: 12 additions & 0 deletions content/docs/developer/centralized-calendar/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Centralized Calendar
---

The Centralized Calendar project is designed to enhance collaboration and cohesiveness within the ICS community. It is an API that aggregates calendar information from participating ICS clubs and provides easy access to events in both ICS and JSON formats.

## Goals

- **Foster Community:** Strengthen the sense of community within ICS.
- **Enhance Cohesiveness:** Promote transparency and cooperation between clubs.
- **Inform Students:** Provide ICS students with clear and accessible information about club events.
- **Streamline Event Viewing:** Simplify the process of viewing events from each club.
5 changes: 5 additions & 0 deletions content/docs/developer/centralized-calendar/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"title": "Centralized Calendar",
"icon": "CalendarCog",
"pages": ["ics-club-guide"]
}
8 changes: 7 additions & 1 deletion content/docs/developer/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"pages": ["index", "---Projects---", "anteaterapi"],
"pages": [
"index",
"---Projects---",
"anteaterapi",
"---Special Projects---",
"centralized-calendar"
],
"root": true
}

0 comments on commit 1daf0a6

Please sign in to comment.