From 14016862f6dde388f3a4fd1d2f80eb4360021ad3 Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Tue, 10 Nov 2015 18:46:45 +0100 Subject: [PATCH 1/6] update get involved page to reflect new structure and developments of last months --- get_involved.md | 40 +++++++++++++++++++++++++++++----------- 1 file changed, 29 insertions(+), 11 deletions(-) diff --git a/get_involved.md b/get_involved.md index 258b30b54..f83879272 100644 --- a/get_involved.md +++ b/get_involved.md @@ -6,30 +6,48 @@ layout: default # How to get involved -Our goal is to make every effort going on as transparent and open as possible. Our official communication channel is the hep-sf-forum. Simply send a mail with ‘subscribe’ as the subject (not content) to hep-sf-forum+subscribe@googlegroups.com +Our goal is to make every effort going on as transparent and open as possible. +Our official communication channel is the hep-sf-forum. Simply send a mail with +‘subscribe’ as the subject (not content) to +hep-sf-forum+subscribe@googlegroups.com -In addition, there is a HEP S&C community mailing list for occasional HEP software and computing community mailings. Everyone involved or interested in HEP S&C is encouraged to sign up to this list. It will be used for occasional mailings of community wide interest, such as announcements of HEP S&C conferences, workshops and schools. +In addition, there is a HEP S&C community mailing list for occasional HEP +software and computing community mailings. Everyone involved or interested in +HEP S&C is encouraged to sign up to this list. It will be used for occasional +mailings of community wide interest, such as announcements of HEP S&C +conferences, workshops and schools. -# Areas for contribution +## Areas for contribution -There are plenty of opportunities for you to contribute to the HSF, be it by participation in technical discussions, by joining one of our working groups, or by joining the HSF with your software project: +There are plenty of opportunities for you to contribute to the HSF, be it by +participation in technical discussions, by joining one of our working groups, or +by joining the HSF with your software project: * Particpation in HSF activities and fora. See the Activities page. - * Participation in HSF events and meetings. + * Participation in HSF events and meetings. * Taking advantage for your project from the HSF (to be created) * Giving input to the HSF startup team * Contributing to this website -# Meetings +## Meetings -See the Events listing on this site for information on HSF meetings, workshops, etc. Meetings use CERN indico for agenda pages. The pages are open to the world, no CERN account needed. So is Vidyo, the conference system we use. Connection info is on the indico pages. However should you need to upload material to the agenda, a CERN account is needed. CERN provides lightweight accounts to non CERN affiliated people when needed. See https://account.cern.ch/account/Externals/ +See the Events listing on this site for information on HSF meetings, workshops, +etc. Meetings use CERN indico for agenda pages. The pages are open to the world, +no CERN account needed. So is Vidyo, the conference system we use. Connection +info is on the indico pages. However should you need to upload material to the +agenda, a CERN account is needed. CERN provides lightweight accounts to non CERN +affiliated people when needed. See https://account.cern.ch/account/Externals/ -# Giving input to the HSF +## Giving input to the HSF Startup Team -In this document we provide background information, guidelines and a questionnaire for giving input to the HSF, and as background to discussions with the HSF startup team. We'd love to hear from you. If you'd like to arrange a discussion, contact any member of the startup team or email the startup team at hep-sf-startup-team@googlegroups.com. +If the existing [fora](/forums.html) do not seem to be the right place to ask +questions or make proposals, feel free to contact the [HSF startup team](hep-sf-startup-team@googlegroups.com.) directly. -This page provides information on adding material to the site. It is visible to those with an editor role, which is pretty much everybody with an approved account. Information on adding content is below. To modify existing content, use the 'edit' tab you find on each content page. Questions are welcome, direct them to Torre Wenaus, wenaus@gmail.com. +## Contributing to this website -# Contributing to the HSF Knowledge Base +You are very welcome to extend this website and add information to it. You can +find instructions on how to do it [here](/howto.html). + +## Contributing to the HSF Knowledge Base The HSF provides a S&C knowledge base cataloging software in use by the community, who uses it, etc. For an introduction to the knowledge base, see the presentation on it at the SLAC workshop. The knowledge base relies on community input if it is to become comprehensive and useful. Please add, update, elaborate, correct entries for your favorite software packages, experiments, etc. All are welcome and encouraged to add and edit material. From 65186c1964ac1130969486483ce9f93202b20a42 Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Tue, 10 Nov 2015 18:55:20 +0100 Subject: [PATCH 2/6] update howto to pull request workflow --- howto.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/howto.md b/howto.md index 5da8305de..92f4db4d2 100644 --- a/howto.md +++ b/howto.md @@ -14,11 +14,16 @@ This website is implemented using [github's Pages service](https://pages.github. ## How to add and edit information -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. +For adding information to this page or improving it, we follow the *[pull request](https://help.github.com/articles/using-pull-requests/)* workflow in GitHub. -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. +Just fork our [HSF website repository](https://github.com/HEP-SF/hep-sf.github.io), edit the +files you want to edit and open a pull request. -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. +If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview your 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. + +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. +So no local checkout is required. ### Adding to the newsletter @@ -42,23 +47,17 @@ Add a new file in `jobs/_posts` and follow the front-matter of the other files in there. It is important to fill the field `open: true`. This field allows to only show positions that aren't filled yet. - -### Sharing and testing drafts -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. - ## Technical details ### Page templates -As of writing, this website contains the following page templates: +As of writing, this website contains the following page templates for wider usage: * default - every page inherits from this - * event - * job_summary - * job - * newsletter - * page - * plain + * event - to be used for events + * job - to be used for job postings + * newsletter - to be used for news items + * plain - to be used for standard contents ### Menu bar and automatization The menu bar is defined in `default.html`, from which all page layouts inherit. From 46e095807fb483bbaa8b2ee69f1b02c4f631cc0c Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Tue, 10 Nov 2015 19:48:46 +0100 Subject: [PATCH 3/6] incorporate comments by Michel's review --- get_involved.md | 15 +++++++++------ howto.md | 10 +++++----- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/get_involved.md b/get_involved.md index f83879272..b43c1e9dc 100644 --- a/get_involved.md +++ b/get_involved.md @@ -8,11 +8,12 @@ layout: default Our goal is to make every effort going on as transparent and open as possible. Our official communication channel is the hep-sf-forum. Simply send a mail with -‘subscribe’ as the subject (not content) to +‘subscribe’ as the subject (no content) to hep-sf-forum+subscribe@googlegroups.com In addition, there is a HEP S&C community mailing list for occasional HEP -software and computing community mailings. Everyone involved or interested in +software and computing community mailings. It is not strictly related to HSF: +Everyone involved or interested in HEP S&C is encouraged to sign up to this list. It will be used for occasional mailings of community wide interest, such as announcements of HEP S&C conferences, workshops and schools. @@ -32,16 +33,18 @@ by joining the HSF with your software project: ## Meetings See the Events listing on this site for information on HSF meetings, workshops, -etc. Meetings use CERN indico for agenda pages. The pages are open to the world, +etc. Meetings use CERN Indico for agenda pages. The pages are open to the world, no CERN account needed. So is Vidyo, the conference system we use. Connection -info is on the indico pages. However should you need to upload material to the +info is on the Indico pages. However should you need to upload material to the agenda, a CERN account is needed. CERN provides lightweight accounts to non CERN affiliated people when needed. See https://account.cern.ch/account/Externals/ ## Giving input to the HSF Startup Team -If the existing [fora](/forums.html) do not seem to be the right place to ask -questions or make proposals, feel free to contact the [HSF startup team](hep-sf-startup-team@googlegroups.com.) directly. +If you are not comfortable with raising an issue in the +[forums](/forums.html] or if you are afraid that this is not the +right place for it, feel free to contact the +[HSF startup team](hep-sf-startup-team@googlegroups.com.) directly. ## Contributing to this website diff --git a/howto.md b/howto.md index 92f4db4d2..5238023fc 100644 --- a/howto.md +++ b/howto.md @@ -6,21 +6,21 @@ layout: default ## About the HSF website -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. +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. ## Implementation -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). +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). ## How to add and edit information For adding information to this page or improving it, we follow the *[pull request](https://help.github.com/articles/using-pull-requests/)* workflow in GitHub. Just fork our [HSF website repository](https://github.com/HEP-SF/hep-sf.github.io), edit the -files you want to edit and open a pull request. - -If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview your 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. +files you want to edit, push them to your fork, and open a pull request. +If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview your submissions. See the [documentation on installing and running Jekyll](https://help.github.com/articles/using-jekyll-with-pages/). +The website uses the master branch of the hep-sf.github.io repository. 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. So no local checkout is required. From 8f594ece5704e70c83530f4c25f14ea963e69a5a Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Tue, 10 Nov 2015 20:33:47 +0100 Subject: [PATCH 4/6] incorporate second set of comments to https://github.com/HEP-SF/hep-sf.github.io/pull/3 --- howto.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/howto.md b/howto.md index 5238023fc..2886a4d78 100644 --- a/howto.md +++ b/howto.md @@ -6,11 +6,12 @@ layout: default ## About the HSF website -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. +This site is maintained by the HSF GitHub [contributors](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. ## Implementation -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). +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. +The site content is written using the easy [Markdown syntax](http://daringfireball.net/projects/markdown/syntax) (which is used by GitHub itself). ## How to add and edit information @@ -19,15 +20,23 @@ For adding information to this page or improving it, we follow the *[pull reques Just fork our [HSF website repository](https://github.com/HEP-SF/hep-sf.github.io), edit the files you want to edit, push them to your fork, and open a pull request. -If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview your submissions. See the [documentation on installing and running Jekyll](https://help.github.com/articles/using-jekyll-with-pages/). +If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview your submissions. See the [documentation](https://help.github.com/articles/using-jekyll-with-pages/) +on installing and running Jekyll. The website uses the master branch of the hep-sf.github.io repository. -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. -So no local checkout is required. + +Despite this is not the recommended option, if you are not comfortable with Git +and you only want to do simple changes, the GitHub web interface allows you to +add and edit the files in your browser. In this case, you don't need to have a +local check-out of your personal fork on GitHub. + +### General structure of website content files +All Markdown files of this site start with a section surrounded by `---`. This +so-called *front-matter* contains metadata about the content. Such metadata are +e.g. the author of the document or the title of the document. ### Adding to the newsletter -Add a new file in `workinggroups/_posts` and follow the front-matter of the +Add a new file in `newsletter/_posts` and follow the front-matter of the other files in there. The list of news will be updated automatically. ### Adding a working group From f2ea8ea118f135efefb752da14ee9ba72527939a Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Tue, 10 Nov 2015 20:58:33 +0100 Subject: [PATCH 5/6] cleanup link anchors and upper- / lower-case mixups --- howto.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/howto.md b/howto.md index 2886a4d78..2522221e8 100644 --- a/howto.md +++ b/howto.md @@ -10,14 +10,14 @@ This site is maintained by the HSF GitHub [contributors](https://github.com/orgs ## Implementation -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. +This website is implemented using [GitHub's Pages](https://pages.github.com/) service 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. The site content is written using the easy [Markdown syntax](http://daringfireball.net/projects/markdown/syntax) (which is used by GitHub itself). ## How to add and edit information For adding information to this page or improving it, we follow the *[pull request](https://help.github.com/articles/using-pull-requests/)* workflow in GitHub. -Just fork our [HSF website repository](https://github.com/HEP-SF/hep-sf.github.io), edit the +Just fork our HSF [website repository](https://github.com/HEP-SF/hep-sf.github.io), edit the files you want to edit, push them to your fork, and open a pull request. If you wish (and it is recommended) you can easily set up a local instance of the newsletter site in order to preview your submissions. See the [documentation](https://help.github.com/articles/using-jekyll-with-pages/) @@ -32,7 +32,7 @@ local check-out of your personal fork on GitHub. ### General structure of website content files All Markdown files of this site start with a section surrounded by `---`. This so-called *front-matter* contains metadata about the content. Such metadata are -e.g. the author of the document or the title of the document. +e.g. the author of the document or the title of the document. ### Adding to the newsletter @@ -76,12 +76,12 @@ down menu `Working Groups`. ### Side bar and automatization The side bar contains two dynamic blocks - *upcoming events* and *current job -openings*. Both are filled with *liquid* snippets defined in `_includes`. +openings*. Both are filled with *Liquid* snippets defined in `_includes`. ## Useful references - [Jekyll](http://jekyllrb.com/) to build websites from plain text -- [The liquid template engine used by Jekyll](https://github.com/Shopify/liquid/wiki) -- [markdown syntax](http://daringfireball.net/projects/markdown/syntax) +- The [Liquid](https://github.com/Shopify/liquid/wiki) template engine used by Jekyll +- [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax From ff5971b01949ba1cc7b80f77575d45c4b2008029 Mon Sep 17 00:00:00 2001 From: Benedikt Hegner Date: Tue, 10 Nov 2015 21:03:56 +0100 Subject: [PATCH 6/6] add link to first mention of Liquid --- howto.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/howto.md b/howto.md index 2522221e8..52c08b0c4 100644 --- a/howto.md +++ b/howto.md @@ -76,7 +76,7 @@ down menu `Working Groups`. ### Side bar and automatization The side bar contains two dynamic blocks - *upcoming events* and *current job -openings*. Both are filled with *Liquid* snippets defined in `_includes`. +openings*. Both are filled with *[Liquid](https://github.com/Shopify/liquid/wiki)* snippets defined in `_includes`.