Skip to content

Commit

Permalink
Update README with more directions
Browse files Browse the repository at this point in the history
  • Loading branch information
mattstratton committed Nov 22, 2015
1 parent 98343be commit 45b982f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,16 @@ Here are the steps to follow to get going as an DevOpsDays content contributor (
1. Install [Hugo](http://gohugo.io)
2. Clone 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.
4. You probably want to do the previous thing in another pane/window, as it needs to keep running. The -w watches for any changes and rebuilds on the fly.
5. When you push to master on github, wercker will automatically build the site and publish it to [http://devopsdays.github.io](http://devopsdays.github.io).

## Creating a new event

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/chicago2015.toml`. Note that the name of the file can NOT include special characters, such as a dash.
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`.

0 comments on commit 45b982f

Please sign in to comment.