Skip to content

Commit

Permalink
Adds other documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mtrythall committed Sep 1, 2024
1 parent b1108db commit a2787c3
Show file tree
Hide file tree
Showing 7 changed files with 84 additions and 11 deletions.
14 changes: 8 additions & 6 deletions src/_content/organizers/_ORGANIZER.md.example
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ name: Firstname Lastname
hidden: false
photo: photo.jpg
role: "Assignment, Assignment"

# Mastodon and Website accept a URL. Other networks accept a handle.
social:
bluesky: handle
github: handle
instagram: handle
mastodon: https://url.com/
twitter: handle
website: https://url.com/
bluesky:
github:
instagram:
mastodon:
twitter:
website:
---
6 changes: 3 additions & 3 deletions src/_content/organizers/_ORGANIZERS
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Organizers can be hidden by setting `hidden: true` in the front matter.
## Adding a new organizer

1. Copy `_ORGANIZER.md.example` to a new file and name it `first-last.md` (e.g. `jane-doe.md`).
2. Fill in the details. You can remove any social networks that are unusued, or leave them blank. Note that `role` is a string, not a list.
4. Add the organizer's photo to the `src/_content/organizers` directory. The photo should be square (or at least portrait-shaped) and at least 600x600 pixels, in JPG or WebP format. The filename should be the same as the organizer's MD file, but with the extension `.jpg` or `.webp` (e.g. `jane-doe.jpg`).
2. Fill in the details. You can remove any social networks that are unusued, leave them blank, or `null`. Note that `role` is a string, not a list.
3. Add the organizer's photo to the `src/_content/organizers` directory. The photo should be square (or at least portrait-shaped) and at least 600x600 pixels, in JPG or WebP format. The filename should be the same as the organizer's MD file, but with the extension `.jpg` or `.webp` (e.g. `jane-doe.jpg`).

## Deleting an organizer

Remove the organizer's MD file and respective photo from the `src/_content/organizers` directory.
Remove the organizer's MD file and their photo from the `src/_content/organizers` directory.
4 changes: 2 additions & 2 deletions src/_content/posts/_POSTS
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Posts can be hidden by setting `hidden: true` in the front matter.
## Adding a new post

1. Copy `_POST.md.example` to a new file and name it `seo-friendly-post-slug.md` (e.g. `announcing-djangocon.md`).
2. Fill in the post metadata. Not all fields are shown every year. The most important fields are: `title`, `published_datetime`, and `cover`. `published_datetime` is used in sitemap.xml, RSS feed generation, and for sorting posts on the news page, so make sure it is accurate. `cover.alt` is used for accessibility.
4. Add post content in Markdown format.
2.
3. Add post content in Markdown format.

### About cover photos

Expand Down
16 changes: 16 additions & 0 deletions src/_content/presenters/_PRESENTER.md.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Firstname Lastname
hidden: false
photo: photo.jpg

# Mastodon and Website accept a URL. Other networks accept a handle.
social:
bluesky:
github:
instagram:
mastodon:
twitter:
website:
---

Presenter's biography here.
20 changes: 20 additions & 0 deletions src/_content/presenters/_PRESENTERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Presenters

Presenters can be seen on the following pages:

- `/schedule/`
- `/{talk,tutorial}/<slug>`

See `src/_includes/presenters-grid.html` for some a listing of presenters.

Presenters can be hidden by setting `hidden: true` in the front matter, though this is not advised when the schedule is active.

## Adding a new presenter

1. Copy `_PRESENTER.md.example` to a new file and name it `first-last.md` (e.g. `jane-doe.md`).
2. Fill in the details. You can remove any social networks that are unusued, leave them blank, or `null`.
3. Add the presenter's photo to the `src/_content/presenters` directory. The photo should be square (or at least portrait-shaped) and at least 600x600 pixels, in JPG or WebP format. The filename should be the same as the organizer's MD file, but with the extension `.jpg` or `.webp` (e.g. `jane-doe.jpg`). Note that presenters and organizers do not share the same photo.

## Deleting an presenter

Remove the presenters's MD file and their photo from the `src/_content/presenters` directory.
21 changes: 21 additions & 0 deletions src/_content/sponsors/SPONSORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Sponsors

Sponsors can be seen at `/sponsors/` and `/`. Sponsors usually appear in lists.

Sponsors can be hidden by setting `hidden: true` in the front matter.

Sponsors are usually returned in their order, as specified in their front matter. You can find the sponsorship level ordering in `src/_data/site.json`.

## Adding a new post

1. Copy `_SPONSOR.md.example` to a new file and name it `sponsor-name.md` (e.g. `lincoln-loop.md`).
2. Fill in the sponsor metadata. There are a few things to keep in mind:
* `level` should be one of the levels defined in `src/_data/site.json`. Casing matters, watch for typos.
* `date` should be the date the sponsorship was added to the site, in the format `YYYY-MM-DD`.
* `hiring_url` is optional. If provided, it will be denoted on the `/sponsors/` page.
* `logo` should be the filename of the sponsor's logo, stored in `src/_content/sponsors/`. The filename should match the sponsor's MD file. Specify the orientation (`portrait` or `landscape`) to aid in rendering. SVG is preferred, but WebP and PNG are also acceptable. Be sure the logo does not have extra whitespace.
3. Add Sponsor content/description in Markdown format after the front matter.

## Deleting an sponsor

Remove the sponsor's MD file and any related logo from the `src/_content/sponsors` directory.s
14 changes: 14 additions & 0 deletions src/_content/sponsors/_SPONSOR.md.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
level: Level
name: "Company Name"
date: YYYY-MM-DD
logo:
filename: company-name.svg
orientation: landscape
hiring_url: false
url:
target: 'https://url.com/'
label: companyname.com
---

Company description in Markdown here.

0 comments on commit a2787c3

Please sign in to comment.