Skip to content
This repository was archived by the owner on Jul 21, 2019. It is now read-only.

Commit 3cebac5

Browse files
mattstrattonmattstratton
authored
Merge pull request #544 from devopsdays/update-docs
Add frontmatter information to reference file
2 parents 9a388e3 + 8ca24b5 commit 3cebac5

1 file changed

Lines changed: 70 additions & 15 deletions

File tree

‎REFERENCE.md‎

Lines changed: 70 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,25 @@
33
# Table of contents
44
<!-- MDTOC maxdepth:6 firsth1:0 numbering:0 flatten:0 bullets:0 updateOnSave:1 -->
55

6-
[Fields in YYYY-CITY.yml](#fields-in-yyyy-cityyml)
7-
&emsp;[General Fields](#general-fields)
8-
&emsp;[Date-related Fields](#date-related-fields)
9-
&emsp;[Branding Fields](#branding-fields)
10-
&emsp;[Location Fields](#location-fields)
11-
&emsp;[Navigation Fields](#navigation-fields)
12-
&emsp;[Organizer Fields](#organizer-fields)
13-
&emsp;&emsp;[Team Members](#team-members)
14-
&emsp;&emsp;[Organizer Emails](#organizer-emails)
15-
&emsp;[Sponsor fields](#sponsor-fields)
16-
&emsp;&emsp;[Sponsor Levels](#sponsor-levels)
17-
&emsp;[Program Fields](#program-fields)
18-
&emsp;&emsp;[Program Items](#program-items)
19-
&emsp;&emsp;&emsp;[Program Element Colors](#program-element-colors)
20-
&emsp;&emsp;[Ignite Fields](#ignite-fields)
6+
[Fields in YYYY-CITY.yml](#fields-in-yyyy-cityyml)
7+
&emsp;[General Fields](#general-fields)
8+
&emsp;[Date-related Fields](#date-related-fields)
9+
&emsp;[Branding Fields](#branding-fields)
10+
&emsp;[Location Fields](#location-fields)
11+
&emsp;[Navigation Fields](#navigation-fields)
12+
&emsp;[Organizer Fields](#organizer-fields)
13+
&emsp;&emsp;[Team Members](#team-members)
14+
&emsp;&emsp;[Organizer Emails](#organizer-emails)
15+
&emsp;[Sponsor fields](#sponsor-fields)
16+
&emsp;&emsp;[Sponsor Levels](#sponsor-levels)
17+
&emsp;[Program Fields](#program-fields)
18+
&emsp;&emsp;[Program Items](#program-items)
19+
&emsp;&emsp;&emsp;[Program Element Colors](#program-element-colors)
20+
&emsp;&emsp;[Ignite Fields](#ignite-fields)
21+
[Pages and Frontmatter](#pages-and-frontmatter)
22+
&emsp;[General Page Fields](#general-page-fields)
23+
&emsp;[Talk Page Fields](#talk-page-fields)
24+
&emsp;[Speaker Page Fields](#speaker-page-fields)
2125

2226
<!-- /MDTOC -->
2327

@@ -211,3 +215,54 @@ ignites:
211215
|------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
212216
| `title` | Yes | The title of the ignite. If it is named after the filename (without the `.md` extension` of a talk, it will generate a link to the talk page. | "matt-stratton" or "DevOps With Delight" |
213217
| `date` | Yes | The date of the ignite, in YYYY-MM-DD format. | 2017-06-16 |
218+
219+
## Pages and Frontmatter
220+
221+
The "frontmatter" refers to the TOML fields at the beginning of all `.md` files in your content directory (i.e., `content/events/2017-ponyville/...`). Frontmatter looks like this:
222+
223+
```
224+
+++
225+
Description = "DevOpsDays Ponyville is back for 2017! We will be hanging out and showing off our awesomeness."
226+
Title = "devopsdays Ponyville 2017"
227+
Type = "welcome"
228+
aliases = ["/events/2017-ponyville/welcome"]
229+
+++
230+
```
231+
232+
The content is everything following the last `+++`.
233+
234+
### General Page Fields
235+
236+
All pages have some common frontmatter elements that they share. These include:
237+
238+
| Field Name | Required | Description | Example |
239+
|---------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
240+
| `Description` | No | The summary, or description, of the content of the page. It is highly recommended that this is populated on every page, as it is used in social sharing, as well as for SEO purposes. | "DevOpsDays Ponyville is back for 2017! We will be hanging out and showing off our awesomeness." |
241+
| `Title` | Yes | The title of the page. This is usually prepopulated for you, but it is highly recommended that you do NOT use the default titles; add some flair to set your event apart. | "devopsdays Ponyville 2017" |
242+
| `Type` | Yes | This is required, but is usually pre-populated. Valid types are "event", "welcome", "program", "speaker", "speakers", and "talk". The type you should use for "regular" pages is "event". | "talk" |
243+
| `aliases` | No | This creates aliases to the page. For example, if you want your index page to also be accessible as `/welcome` under your event, you would add the alias here. | ["/events/2017-ponyville/welcome"] |
244+
245+
### Talk Page Fields
246+
247+
Pages of the type `talk` (which can include workshops, ignites, or talks) have a few additional frontmatter elements available to them, in addition to the ones mentioned above.
248+
249+
| Field Name | Required | Description | Example |
250+
|---------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
251+
| `speakers` | Yes | An array of the names of the speakers (relative to the filenames for the speaker in your `content/events/YYYY-CITY/speakers` directory). Even if there is only one speaker, it should be formatted as an array. | speakers = ["fluttershy", "spike"] |
252+
| `youtube` | No | The ID of the YouTube video (not the full URL). | "8ClZXJsgpHY" |
253+
| `vimeo` | No | The ID of the Vimeo video (not the full URL). | "219025568" |
254+
| `speakerdeck` | No | The URL to the talk on Speakerdeck. Use the full URL. | "https://speakerdeck.com/mattstratton/shifting-left-securely" |
255+
| `slideshare` | No | The URL to the talk on Slideshare. Use the full URL | "http://www.slideshare.net/mattstratton/the-five-love-languages-of-devops-54549536" |
256+
| `slides` | No | If the slides are available on a service other than Speakerdeck or Slideshare, enter the URL here. | "http://www.mattstratton.com/my-slides" |
257+
258+
### Speaker Page Fields
259+
260+
Pages of the type `speaker` have a few additional frontmatter elements available to them, in addition to the general ones mentioned above.
261+
262+
| Field Name | Required | Description | Example |
263+
|------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|
264+
| `website` | No | An array of the names of the speakers (relative to the filenames for the speaker in your `content/events/YYYY-CITY/speakers` directory). Even if there is only one speaker, it should be formatted as an array. | "https://www.mattstratton.io" |
265+
| `twitter` | No | Speaker's Twitter username, without the @. | "mattstratton" |
266+
| `facebook` | No | Speaker's Facebook URL | "https://www.facebook.com/matt.stratton" |
267+
| `linkedin` | No | Speaker's LinkedIn URL | "https://www.linkedin.com/in/mattstratton/" |
268+
| `github` | No | Speakers' GitHub username. | "mattstratton" |

0 commit comments

Comments
 (0)