Skip to content

Commit

Permalink
Merge commit '3d2bed731ad3112da2522805c1f3c9a8bec6f325' into blaker-e…
Browse files Browse the repository at this point in the history
…vent
  • Loading branch information
Brilator committed Oct 15, 2024
2 parents 1793136 + 3d2bed7 commit 910355b
Show file tree
Hide file tree
Showing 52 changed files with 702 additions and 359 deletions.
176 changes: 121 additions & 55 deletions .github/ISSUE_TEMPLATE/event.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,36 @@ description: Add an event (e.g. workshop, training or demo) to be listed on the
title: "[Add event]: "
body:
- type: input
id: start
attributes:
label: Event start time
description: e.g. 2024-10-24T09:00:00
validations:
required: true
- type: input
id: end
id: title
attributes:
label: Event end time
description: e.g. 2024-10-24T12:00:00
label: Title
validations:
required: true
- type: input
id: title
id: description
attributes:
label: Event title
label: Description
description: Max. 200 signs.
validations:
required: true
- type: input
id: organizer
- type: dropdown
id: mode
attributes:
label: Organizer(s)
description: Name(s) of contact person(s)
validations:
required: false
- type: input
id: tutors
label: Mode
options:
- On-site
- Online
- Hybrid
- type: dropdown
id: category
attributes:
label: Tutor(s)
description: Name(s) of tutor(s)
validations:
required: false
label: Category
options:
- Conference
- Hackathon
- Webinar
- Training
- Meeting
- type: dropdown
id: audience
attributes:
Expand All @@ -44,49 +41,118 @@ body:
- Users
- Data Stewards
- Developers
- Everyone
multiple: true
validations:
required: false
- type: input
id: registration-url
- type: dropdown
id: recurrence
attributes:
label: Recurrence
options:
- Single
- Periodic
- Series
description: |
Single = one-time event; Series = multiple-session event planned for non-consecutive days; Periodic = regularily repeating (e.g. Data Steward Circle)
- type: textarea
id: when
attributes:
label: When
value: |
# Single event
start: 2024-10-24T09:00:00
end: 2024-10-24T12:00:00
# Multi event (consecutive days)
start: 2024-10-24T09:00:00
end: 2024-10-25T17:00:00
# Multi event (non-consecutive days)
-
start: 2024-10-24T09:00:00
end: 2024-10-24T17:00:00
-
start: 2024-10-31T09:00:00
end: 2024-10-31T17:00:00
render: markdown
validations:
required: true
- type: textarea
id: organizer
attributes:
label: Registration link or contact
label: Organizer
value: |
organizer:
name:
affiliation:
url:
description: |
Details of responsible person, e.g.
organizer:
name: Mrs. Organize-A-Lot
affiliation: DataPLANT
url: https://www.nfdi4plants.org
validations:
required: false
- type: input
id: registration-deadline
required: true
- type: textarea
id: tutors
attributes:
label: Registration deadline
description: Registration deadline date
label: Tutors
description: List of tutors
value: |
- Sir Tutor-A-Lot (<a href="https://www.nfdi4plants.org">DataPLANT</a>)
- Edna Krabappel
validations:
required: false
- type: input
id: registration-seats
- type: textarea
id: registration
attributes:
label: Max. number of seats
label: Registration
value: |
url:
description:
deadline:
seats:
description: |
url: link to a registration form or a mailto-link (email address)
description: add additional details to the registration
deadline: 2024-10-12
seats: Max. number of participants
render: markdown
validations:
required: false
- type: dropdown
id: mode
- type: textarea
id: location
attributes:
label: Event mode
options:
- On-site
- Online
- Hybrid
- type: dropdown
id: category
label: Location
value: |
url:
name:
address:
description: |
url: link to hybrid meeting or directions (e.g. online map)
name: 50 signs max.
address: Street address and room
render: markdown
validations:
required: false
- type: textarea
id: detail
attributes:
label: Event category
options:
- Conference
- Hackathon
- Webinar
- Training
description: Use this free-text area to describe your event with more detail
label: Detail
value: |
# About this event
...
# Teaching Materials
...
- type: input
id: location
id: image
attributes:
label: Event location
description: location address, room // hybrid meeting link

label: Image
description: add an image URL here or upload an image via comment to the issue
87 changes: 72 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,30 +249,38 @@ The frontmatter for an event looks like this:

```yaml
---
date: 2024-10-24
title: ARCify your research project
category: Training
excerpt: 'Learn how to move your datasets into ARCs, share them via the DataHUB, and annotate them with metadata.'
start: 2024-10-24T09:00:00
end: 2024-10-24T12:00:00
category: Training
mode: On-site
audience: [Users, DataStewards]
location:
short: HHU
url: https://www.ceplas.eu/en/contact/how-to-get-there
image: ~/assets/images/events/ceplas-ARCs.drawio.png
when:
start: 2024-10-24T09:00:00
end: 2024-10-24T12:00:00
# -- or for repeating events --
# -
# start: 2024-10-24
# end: 2024-10-25
# -
# start: 2024-11-24
# end: 2024-11-25
tutors:
- Dominik Brilhaus (CEPLAS)
- Sabrina Zander (MibiNet)
image: ~/assets/images/events/ceplas-ARCs.drawio.png
organizer:
name: Dominik Brilhaus
affiliation: CEPLAS Data
url: https://www.ceplas.eu/en/research/data-science-and-data-management
location:
short: HHU
url: https://www.ceplas.eu/en/contact/how-to-get-there
registration:
description: 'First-come-first-serve. Members of CEPLAS have priority. Everyone else is welcome, if seats are available.'
url: 'https://terminplaner6.dfn.de/en/b/551776b4130c40357ea030db0142f472-910401'
deadline: 2024-10-17
seats: 12
external: https://en.wikipedia.org/wiki/URL#:~:text=A%20typical%20URL%20could%20have,html%20).
---
```

Expand All @@ -281,12 +289,10 @@ with these fields:

| Field name | description | Note |
| ------------- | --------------------------------------------------------------------- | ------------ |
| `date` | The date of the event | **Mandatory** |
| `title` | The title of the event | **Mandatory** |
| `category` | The category of the event | one of Conference', 'Hackathon', 'Webinar', 'Training', **Mandatory** |
| `excerpt` | A brief description of the event | **Mandatory** |
| `start` | The start date and time of the event in ISO 8601 format | **Mandatory** |
| `end` | The end date and time of the event in ISO 8601 format | **Mandatory** |
| `category` | The category of the event | one of Conference', 'Hackathon', 'Webinar', 'Training', **Mandatory** |
| `when` | Event instantiation(s) | Either a single object or an array of 'when's , containing the start and end date and time of the event in ISO 8601 format. **Mandatory** |
| `mode` | The mode of the event (e.g., online, on-site) | one of 'On-site', 'Online', 'Hybrid', **Mandatory** |
| `audience` | The intended audience of the event | array of 'Users', 'DataStewards', 'Developers', 'Everyone', **Mandatory** |
| `location` | The location information for the event | **Mandatory** |
Expand All @@ -300,8 +306,9 @@ with these fields:

| Field name | description | Note |
| ---------- | ---------------------------------------- | ------------ |
| `short` | A short name or abbreviation of the location | **Optional** |
| `name` | A short name or abbreviation of the location | **Mandatory** |
| `url` | The URL with directions or location info | **Optional** |
| `address` | The address of the location in freetext | **Optional** |

`tutors` is an array of strings listing the names and affiliations of event tutors.

Expand All @@ -322,6 +329,54 @@ with these fields:
| `deadline` | The deadline for registration in YYYY-MM-DD format | **Optional** |
| `seats` | The number of available seats | **Optional** |

`when` can be either a single object or an array of objects, each containing the start and end date and time of the event in ISO 8601 format.

Single:

```yaml
when:
start: 2024-10-24T09:00:00
end: 2024-10-24T12:00:00
```

Repeating:

Using a list of objects will create multiple instances of the event. This is useful for events that repeat on a regular basis.

```yaml
when:
-
start: 2024-10-24T09:00:00
end: 2024-10-25T12:00:00
-
start: 2024-11-24T09:00:00
end: 2024-11-25T12:00:00
```

You can give optional props to single instantiantions of a event using the syntax below. The `props` object can have any field the base type has, but it is not mandatory to provide all fields.

> [!CAUTION]
> If you replace any object field, for example `registration`, you must provide all subfields for this object you want to use. You cannot partially replace an object field.

```yaml
when:
-
start: 2024-10-24T09:00:00
end: 2024-10-25T12:00:00
-
start: 2024-11-24T09:00:00
end: 2024-11-25T12:00:00
props:
registration:
description: 'First-come-first-serve. Members of CEPLAS have priority. Everyone else is welcome, if seats are available.'
url: 'https://an-entirely-different-url.com'
deadline: 2024-11-17
seats: 42
```

In this example the event on 2024-11-24 has a specific different registration object.


### News

News are generated from markdown files in `src/content/news`.
Expand Down Expand Up @@ -434,9 +489,11 @@ All files found here will be used to generate a file structure like `/articles/:

#### `src/content/events`

All files found here will be used to generate a file structure like `/events/:slug`. The slug is automatically generated from the filename. The file responsible for generating the respective layout is `/src/pages/events/[...slug].astro`.
All files found here are used to generate the page `/events/...` structure. Multiple pages are created for this content:

All content events are display in `/src/pages/events/index.astro`.
- `/events` is a list of all events (from `/src/pages/events/index.astro`)
- `/events/[slug]`, where slug is the file name or a frontmatter `slug` property. This can be any of two, a detailed view on a single event or a list of events for repeating events (`when` is array, from `/src/pages/[event]/index.astro`).
- `/events/[slug]/[dd-MM-yyyy]`, slug as above, `dd-MM-yyyy` is `when`.`start` of the specific event instantiation (e.g. `13-11-2024`). This is always a detailed view on a single event (from `src/pages/events/[event]/[date].astro`).

#### `src/content/news`

Expand Down
2 changes: 1 addition & 1 deletion src/components/MainPageCard.astro
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ let textColor = textColorMap.get(card.data.styling.textColor)
let buttonColor = bgColorMap.get(card.data.styling.buttonColor)
let buttonTextColor = textColorMap.get(card.data.styling.buttonTextColor)
const cardBaseClass = card.data.styling.glass ? "card glass lg:!items-center" : "card lg:!items-center"
const cardBaseClass = card.data.styling.glass ? "card glass max-md:rounded-none lg:!items-center" : "card max-md:rounded-none lg:!items-center"
const cardClassTextRight = `${cardBaseClass} lg:card-side shadow-xl p-6 ${bgColor} ${textColor}`
const cardClassTextLeft = `${cardBaseClass} lg:card-side shadow-xl p-6 ${bgColor} ${textColor}`
Expand Down
Loading

0 comments on commit 910355b

Please sign in to comment.