Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Enabling viewing events in GitHub with reorg #1032

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

colindean
Copy link
Contributor

With more than 1,000 files in a directory, it's not possible to view all files and thus requires searching. This reorganization makes it easier to see all events for a year in the repository by looking in a directory specifically for that year.

This should not change the public API/schema of /events/events.json, but it does change how Jekyll represents it internally, thus requiring the new Liquid filter to manipulate Jekyll's structure into the form the data used to enter into the templates.

Fixes #1030

With more than 1,000 files in a directory, it's not possible to view all
files and thus requires searching. This reorganization makes it easier
to see all events for a year in the repository by looking in a directory
specifically for that year.

This should not change the public API/schema of /events/events.json,
but it does change how Jekyll represents it internally, thus requiring
the new Liquid filter to manipulate Jekyll's structure into the form
the data used to enter into the templates.

Fixes coderetreat#1030
This properly communicates the expectation to put files into the
appropriate directory by year.

This also fixes a longstanding issue with the naming suggestion omitting
the date for the filename itself.
@colindean
Copy link
Contributor Author

I'm not seemingly able to reproduce the build failure in my devcontainers/Codespace as configured to fix problems reported in #1031.

@rradczewski
Copy link
Contributor

Thank you @colindean , this is a very useful change and a good middle-way between how we used to do it (separate collections per year, manually changing the year over) and how we did it until now so that we don't have to do the manual step any more.

Problem is, a lot of the tests and tooling expect events to be exactly in ./_data/events/*.json files, so the PR will necessarily have to get a bit bigger.

The GitHub CLI was rather uncooperative in pushing changes to your branch, but I've added some commits here: https://github.com/coderetreat/coderetreat.org/tree/gh1030-organize-events-by-year

We will have to make sure the following works:

  • automerger action (./.github/actions/automerger) must be changed (see my failed attempt in the branch)
  • cypress test and fixture need to change (same thing, but I have yet to run the cypress tests)
  • unit test / schema validation needs to actually test the event files (that one I've managed)

@mplavcan and I can work on this in a couple of weeks and see how far we get it. Thanks for the initial push!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize _data/events to restore GitHub editability
2 participants