Create an EVENTS Help Document

[snohio]

Create an EVENTS Help Document

User Story

As a member of Orlando Devs group, I would like to have an events.md document in the root of the repo so that event and group organizers know how to create an event file to be published.

Tasks

• Include instructions on creating a branch, what is required in the file, where the images go, and basic instructions on the PR and approval flow process.

[snohio]

Not that it really matters, but should we have a standard naming convention for these?

[wgeorgecook]

Honestly I think a script that generates the template would be the way to go.

[wildaces215]

I might be interested in this but I had a few questions:

1. Is there already a template that is used for creating .md files? Like theres a header and a subheader with a text body?
2. Do you want me to make a script to generate the template? Please note I did not get a chance to look at all the source code yet.
   Thanks!

[wgeorgecook]

@wildaces215 Thanks for your interest! When you have a moment, please give the Event Administration section of the readme a look over. That points you to where my most basic attempt at automating this lives. It leaves much to be desired. To that end, I'm working on an action and a script to actually generate the real event markdown based on a template. I'm sticking with bash for portability, but as long as we can run the script on the Actions runner it doesn't super matter. You can see my (very much in progress) work here and here. They're both on the new-event-workflow branch.

I've been working out of #27 for the actual action and script. I believe any changes to the documentation should live in this issue.

[wildaces215]

Ok then I'll most likely start on making the documentation then, currently my only other question is what branch to use for documentation?

[wgeorgecook]

@wildaces215 We don't have one currently, so you'll have to make one. Please fork from main and run wild!

[snohio]

We now have a naming convention for the events in /src/content/events.
it starts with the yearmonthday and then - and short title and it should end in md. There should be no spaces and letters lowercase such as 20250703-devops-storytime-social.md This helps keep them in order.

There is currently not a "Previous Events" folder yet, maybe at the end of the year, we will archive old events and create a 2025 link.

The documentation is still needed.