Written General and End User Documentation Centralized calendar #17
Conversation
| 1. **Open Google Calendar:** | ||
|
|
||
| - Go to [Google Calendar](https://calendar.google.com). | ||
|
|
||
| 2. **Access Calendar Settings:** | ||
|
|
||
| - On the left sidebar, hover over the calendar you want to share. | ||
| - Click on the three vertical dots that appear and select "Settings and sharing." | ||
|
|
||
| 3. **Get the Shareable Link:** | ||
|
|
||
| - Scroll down to the "Access permissions for events" section. | ||
| - Check the box that says "Make available to public." | ||
| - Scroll further down to the "Integrate calendar" section. | ||
| - Copy the "Public address in iCal format" link. | ||
|
|
||
| 4. **Submit Your Calendar Link:** | ||
| - Send the copied calendar link to our project team leads ([Alex](https://github.com/alexanderl19), [Eddy](https://github.com/ecxyzzy)). |
There was a problem hiding this comment.
Use built-in steps component.
|
|
||
| ### 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 6 hours. This ensures that any new events or changes to existing events that have not happened yet are reflected in the ics-centralized-calendar quickly. |
There was a problem hiding this comment.
I think that saying the repo name "ics-centralized-calendar" becomes wordy quickly. What are you thoughts on phrasing along the times of "integrated into our calendar system"?
|
|
||
| ### 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 6 hours. This ensures that any new events or changes to existing events that have not happened yet are reflected in the ics-centralized-calendar quickly. |
There was a problem hiding this comment.
Is specifying the exact time period too specific. I'm worried that this information can become quickly out of date. Also as a separate question, was there a reason we settled on 6 hours? That seems like a very long period to me.
Maybe something like "... your events will be updated automatically. Updates may take up to x hours to reflect on our end." adds more clarity?
|
|
||
| - **Title:** A clear description 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. |
There was a problem hiding this comment.
Do we not use the location field on the event? If so this should be reflected here. If not, I feel like this might be a small oversight.
|
|
||
| ### How can I make changes to my events? | ||
|
|
||
| Simply update your events in your Google Calendar. The changes will be reflected in the ics-centralized-calendar during the next update cycle. |
There was a problem hiding this comment.
Potentially use the same very explicit wording as before, indicating that changes may take up to x to reflect.
|
|
||
| ### How do I change or remove my club's calendar from the centralized calendar? | ||
|
|
||
| Contact our project leads([Alex](https://github.com/alexanderl19), [Eddy](https://github.com/ecxyzzy)) to change or remove your calendar URL from the ics-centralized-calendar. |
There was a problem hiding this comment.
While we encourage all ICS clubs to participate, email [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.
|
|
||
| ### Who do I contact for support? | ||
|
|
||
| If you have any questions or need assistance, contact our project leads ([Alex](https://github.com/alexanderl19), [Eddy](https://github.com/ecxyzzy)). |
There was a problem hiding this comment.
please email [email protected] or contact our EVP.
|
|
||
| ## Introduction | ||
|
|
||
| The `ics-centralized-calendar` project is an easy to use API meant to provide centralized access to all ICS calendars, offering options for selecting specific clubs and output formats (ICS or JSON). |
There was a problem hiding this comment.
I think approaching this introduction from a more project / goal oriented mindset might be more suitable for this page.
Something that covers:
- Bring the ICS community closer
- Makes your events easier to discover
- Helps us promote ICS events better
I don't think explaining that this project is an API is necessarily useful for the target audience of this doc (other clubs).
| The ics-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 | ||
|
|
There was a problem hiding this comment.
Also better publicize ICS club events
Written the general alongside the end-user documentation for our ics-centralized-calendar project. Let me know if I should redo or edit the documentation.
This pull request resolves #15