Skip to content

Commit d3426bd

Browse files
author
Benedikt Hegner
committed
update howto to reflect new document types and structure
1 parent 936eaba commit d3426bd

File tree

1 file changed

+41
-45
lines changed

1 file changed

+41
-45
lines changed

howto.md

Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,76 +4,72 @@ author: Torre Wenaus
44
layout: default
55
---
66

7-
## About the newsletter site
7+
## About the HSF website
88

9-
This site is maintained by the [HSF github repository people](https://github.com/orgs/HEP-SF/people). If you're interested to become one contact the HSF startup team or any team member. It was set up by Torre Wenaus.
9+
This site is maintained by the [HSF github repository people](https://github.com/orgs/HEP-SF/people). If you're interested to become one contact the HSF startup team or any team member. It was set up by Torre Wenaus and Benedikt Hegner.
1010

1111
## Implementation
1212

13-
This HSF newsletter website is implemented using [github's Pages service](https://pages.github.com/) which makes it easy to create a website associated with a github account or project. [Pages uses Jekyll](https://help.github.com/articles/using-jekyll-with-pages/), a tool to automatically build a website from source files (which are kept in github). It supports structured sites like blogs in a simple but powerful way. We all like to work in code editors; this lets you write content in a friendly editor using the easy [markdown syntax](http://daringfireball.net/projects/markdown/syntax) (which is used by github itself).
13+
This website is implemented using [github's Pages service](https://pages.github.com/) which makes it easy to create a website associated with a github account or project. [Pages uses Jekyll](https://help.github.com/articles/using-jekyll-with-pages/), a tool to automatically build a website from source files (which are kept in github). It supports structured sites like blogs in a simple but powerful way. We all like to work in code editors; this lets you write content in a friendly editor using the easy [markdown syntax](http://daringfireball.net/projects/markdown/syntax) (which is used by github itself).
1414

15-
## How to post
15+
## How to add and edit information
1616

17-
To create a post you add a file in the [github repository of posting sources](https://github.com/HEP-SF/hep-sf.github.io/tree/master/_posts), so you need to be an [HSF github repository](https://github.com/HEP-SF) user. Talk to any member of the startup team.
17+
To create or edit files you have to use the [github repository of the HSF website](https://github.com/HEP-SF/hep-sf.github.io/), so you need to be an [HSF github repository](https://github.com/HEP-SF) user. Talk to any member of the startup team.
1818

19-
If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview submissions. See the [documentation on installing and running Jekyll](https://help.github.com/articles/using-jekyll-with-pages/). The newsletter uses user pages, ie use the master branch.
19+
If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview submissions. See the [documentation on installing and running Jekyll](https://help.github.com/articles/using-jekyll-with-pages/). The website uses user pages, ie use the master branch.
2020

21-
### Sharing and testing drafts
22-
If you want to store a draft of a post, you can put it into the `_drafts/` folder. Adding `--drafts` to the command line of jekyll allows you to render them locally. Once happy, `git mv` it into the `_posts/` directory and publish to the official repository.
23-
24-
## What to post
25-
26-
Here's a template. This snippet covers the entire content of what should be in the post file. Note that the first lines enclosed by three dashes must be the first lines in the file. The format is markdown, see references below.
21+
If you only do simple operations like the ones mentioned below, the GitHub interface itself gives you all options to add and edit such files in the browser.
2722

28-
The file must be added to the [_posts directory](https://github.com/HEP-SF/hep-sf.github.io/tree/master/_posts) following the name convention `yyyy-mm-dd-title-goes-here.md`.
23+
### Adding to the newsletter
2924

30-
---
31-
title: HEP Software Foundation news, May 1 2015 (required)
32-
project: Project name if the post is about a particular project (optional)
33-
tags: tags for software category, etc. (optional)
34-
author: you (optional)
35-
---
25+
Add a new file in `workinggroups/_posts` and follow the front-matter of the
26+
other files in there. The list of news will be updated automatically.
3627

37-
HEP Software Foundation news this week: (include the sections for which you're giving updates)
28+
### Adding a working group
3829

39-
## Packaging
40-
41-
## Software projects
30+
Add a new file in `workinggroups/_posts` and follow the front-matter of the
31+
other files in there. The navigation bar will be updated automatically.
4232

43-
## Training
33+
### Adding an event
4434

45-
## Development tools
35+
Add a new file in `events/_posts` and follow the front-matter of the other files
36+
in there. The events page will be updated automatically. Please don't forget
37+
adding a startdate. Only this allows a proper ordering
4638

47-
## Knowledge base
39+
### Adding a job opening
4840

49-
## Technical notes
41+
Add a new file in `jobs/_posts` and follow the front-matter of the other files
42+
in there. It is important to fill the field `open: true`. This field allows to
43+
only show positions that aren't filled yet.
5044

51-
## Forum news
5245

53-
## Licenses
54-
55-
## Recent meetings
46+
### Sharing and testing drafts
47+
You can either use the github approach of forking a repository, do your changes there and make a pull request. Or if you want to store the draft into the main repository directly, you can put it into the `_drafts/` folder. Adding `--drafts` to the command line of jekyll allows you to render them locally. Once happy, `git mv` it into the `_posts/` directory and publish to the official repository.
5648

57-
## Coming events
58-
59-
You can also have subsections
49+
## Technical details
6050

61-
### Subsection
51+
### Page templates
6252

63-
(you get the idea). You can include a link [here](http://path), use
53+
As of writing, this website contains the following page templates:
6454

65-
* bulleted
66-
* nested
67-
* lists
55+
* default - every page inherits from this
56+
* event
57+
* job_summary
58+
* job
59+
* newsletter
60+
* page
61+
* plain
6862

69-
and refer to `inline code` and
63+
### Menu bar and automatization
64+
The menu bar is defined in `default.html`, from which all page layouts inherit.
65+
The layout is hard-coded except for the addition of working groups. A new post
66+
in the `workinggroups/_posts` directory automatically adds the group to the drop
67+
down menu `Working Groups`.
7068

71-
include
72-
large
73-
code
74-
blocks.
69+
### Side bar and automatization
70+
The side bar contains two dynamic blocks - *upcoming events* and *current job
71+
openings*. Both are filled with *liquid* snippets defined in `_includes`.
7572

76-
See the markdown doc for more.
7773

7874

7975
## Useful references

0 commit comments

Comments
 (0)