Skip to content

Commit

Permalink
Merge pull request #72 from devopsdays/add-sample-event
Browse files Browse the repository at this point in the history
Add sample event

Former-commit-id: a98f6d5
  • Loading branch information
mattstratton committed Mar 7, 2016
2 parents ae2b2a1 + 365b96b commit d1e97c1
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This is the website for DevOpsDays.org

Here are the steps to follow to get going as an DevOpsDays content contributor (or heck, even a code contributor)

1. Install [Hugo v0.15+](http://gohugo.io)
1. Install [Hugo v0.15+](http://gohugo.io)
2. Fork this repo
3. If you want to fire up a local copy to see your changes as you go, enter this command `hugo server -w --baseUrl="http://localhost:1313"`
4. The `--baseUrl` flag is kind of flaky, so a good solution is to change the `config.toml` file to point to `localhost` before starting `hugo server -w`. DO NOT COMMIT THIS CHANGED FILE BACK TO GITHUB. Just exclude it for now. We don't add it to `.gitignore` because we might need to muck with that file...although once everything is stable we might do this for safety.
Expand All @@ -27,7 +27,9 @@ Here are the steps to follow to get going as an DevOpsDays content contributor (
This is by no means complete, but a couple things to know:

1. Create a data file for your event in `data/events`, for example, `data/events/2015chicago.yml`. Note that the name of the file can NOT include special characters, such as a dash. It should follow the format of `yyyycity.yml`. It is highly recommended to just duplicate one from another event.
2. Generate the pages for your event, in the following manner for each page. `hugo new events/2016-kiel/welcome.md --kind=event`
3. The `welcome.md` file needs to have a field added to its frontmatter for the alias, i.e., `aliases = ["/events/2015-chicago"]`
4. Sponsors each need a file in the data directory, as such: `data/sponsors/chef.yml`. If there is an existing sponsor and you can use it, you do not need to create the data file (or the image). If your information is different, please create a new file, such as `data/sponsors/2015chicagochef.yml`. Again, no special characters in the filename, please.
5. Put the images for your sponsors in the `/static/img/sponsors` directory. They need to be PNG files and named exactly after the name of the sponsor in your event file (and the corresponding sponsor data file), i.e., `/static/img/sponsors/chef.png`..
2. You can either copy the files from the `/content/events/sample-event` directory into a directory named `/content/events/YYYY-city`, or do it manually as listed below.
3. Generate the pages for your event, in the following manner for each page. `hugo new events/2016-kiel/welcome.md --kind=event`
4. The `welcome.md` file needs to have a field added to its frontmatter for the alias, i.e., `aliases = ["/events/2015-chicago"]`
5. Sponsors each need a file in the data directory, as such: `data/sponsors/chef.yml`. If there is an existing sponsor and you can use it, you do not need to create the data file (or the image). If your information is different, please create a new file, such as `data/sponsors/2015chicagochef.yml`. Again, no special characters in the filename, please. (Note: there is an experimental feature for an "override" of the sponsor data; more on this feature as it is developed)
6. Put the images for your sponsors in the `/static/img/sponsors` directory. They need to be PNG files and named exactly after the name of the sponsor in your event file (and the corresponding sponsor data file), i.e., `/static/img/sponsors/chef.png`.
7. You will also want to add your event's logo to the following directory (creating the directory if necessary) `/static/img/yyyy-city/logo.png`. The file MUST be called `logo.png`.
11 changes: 11 additions & 0 deletions content/events/sample-event/conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
City = ""
Description = ""
Year = ""
date = "2016-03-06T21:17:08-06:00"
event = ""
title = "conduct"
type = "event"

+++

11 changes: 11 additions & 0 deletions content/events/sample-event/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
City = ""
Description = ""
Year = ""
date = "2016-03-06T21:16:08-06:00"
event = ""
title = "contact"
type = "event"

+++

11 changes: 11 additions & 0 deletions content/events/sample-event/location.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
City = ""
Description = ""
Year = ""
date = "2016-03-06T21:17:00-06:00"
event = ""
title = "location"
type = "event"

+++

11 changes: 11 additions & 0 deletions content/events/sample-event/sponsor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+++
City = ""
Description = ""
Year = ""
date = "2016-03-06T21:17:14-06:00"
event = ""
title = "sponsor"
type = "event"

+++

10 changes: 10 additions & 0 deletions content/events/sample-event/welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
+++
Categories = []
Description = ""
Tags = []
date = "2016-03-06T21:15:25-06:00"
title = "welcome"
type = "event"
aliases = ["/events/YYYY-city"]

+++
Empty file.

0 comments on commit d1e97c1

Please sign in to comment.