Skip to content

Commit 48d0bb9

Browse files
JavierCVillaagheata
JavierCVilla
authored and
agheata
committed
[WIP] Prepare website for Season of Docs (HSF#555)
* Prepare website for Season of Docs * Fix cern description in multiple places * Add new mailing list
1 parent 2af40fa commit 48d0bb9

File tree

15 files changed

+253
-7
lines changed

15 files changed

+253
-7
lines changed

‎_activities/gsdocs.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: "Season of Docs"
3+
author: "Javier Cervantes"
4+
layout: default
5+
---
6+
7+
# ![CERN](/images/CERN-logo.jpg){:height="100px"} ![HSF](/images/hsf_logo_angled.png){:height="100px"} Season of Docs 2019
8+
9+
## Introduction
10+
11+
[Season of Docs](https://developers.google.com/season-of-docs/) is a program that brings technical writers and open source projects together for a few months to work on open source documentation.
12+
13+
Particle physics is an exciting field where large collaborations of scientists collect
14+
and analyze petabytes data from high-energy physics experiments, such as the Large Hadron Collider,
15+
hosted at the CERN laboratory in Geneva, Switzerland.
16+
Some of the questions that we collectively ask are:
17+
18+
- what are the fundamental blocks that make up our Universe?
19+
- what is the nature of dark matter and dark energy?
20+
- what is the nature of the asymmetry between matter and antimatter?
21+
- what was early Universe like?
22+
23+
To answer these questions, particle physicists build software to simulate and analyze what happens in particle physics detectors.
24+
25+
Since 2011, CERN has participated in other Google initiatives such as Google Summer of Code (GSoC), first as a small organization (CERN-SFT) and later as an umbrella organization (CERN-HSF) to involve the high-energy physics community. Given the good results in the past under the GSoC program, CERN-HSF is eager to participate in this first edition of Season of Docs.
26+
27+
28+
### Season of Docs 2019
29+
30+
In 2019 CERN-HSF is planning to apply as an umbrella organization, project proposals are listed [below](#projects-in-2019).
31+
32+
33+
## Projects in 2019
34+
35+
{% assign current_year = "2019" %}
36+
{% include gsdocs_project_list.ext year=current_year %}
37+
38+
## Participating Organizations in 2019
39+
40+
{% include gsdocs_organization_list.ext year=current_year %}
41+
42+
## Summary
43+
44+
[Full list of Proposal Ideas](/gsdocs/2019/summary.html)
45+
46+
[Full list of Mentors](/gsdocs/2019/mentors.html)
47+
48+
---
49+
50+
*HSF Season of Docs Administrators*: Andrei Gheata and Javier Cervantes Villanueva.
51+
52+
[Contact us](mailto:[email protected])
53+
[General e-mail](mailto:[email protected])

‎_config.yml

+9
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ collections:
2424
gsocproposals:
2525
output: true
2626
permalink: /gsoc/:path.html
27+
gsdocs-orgs:
28+
output: true
29+
permalink: /gsdocs/organizations/:path.html
30+
gsdocs-projects:
31+
output: true
32+
permalink: /gsdocs/projects/:path.html
33+
gsdocs-proposals:
34+
output: true
35+
permalink: /gsdocs/:path.html
2736
workinggroups:
2837
output: true
2938
permalink: /workinggroups/:title.html

‎_gsdocs-orgs/2019/cern.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "CERN"
3+
author: "Benedikt Hegner"
4+
layout: default
5+
organization: CERN
6+
logo: CERN-logo.jpg
7+
description: |
8+
At CERN, the European Organization for Nuclear Research, physicists and engineers are probing the fundamental structure of the universe. They use the world's largest and most complex scientific instruments to study the basic constituents of matter – the fundamental particles.
9+
---
10+
11+
{% include gsdocs_proposal.ext %}

‎_gsdocs-projects/2019/.empty

Whitespace-only changes.

‎_gsdocs-proposals/2019/.empty

Whitespace-only changes.

‎_gsocorgs/2018/cern.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ layout: default
55
organization: CERN
66
logo: CERN-logo.jpg
77
description: |
8-
At CERN, the European Organization for Nuclear Research, physicists and engineers are probing the fundamental
9-
structure of the universe. They use the world's largest and most complex scientific instruments to study the
10-
basic constituents of matter – the fundamental particles.
8+
At CERN, the European Organization for Nuclear Research, physicists and engineers are probing the fundamental structure of the universe. They use the world's largest and most complex scientific instruments to study the basic constituents of matter – the fundamental particles.
119
---
1210

1311
{% include gsoc_proposal.ext %}

‎_gsocorgs/2019/cern.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ layout: default
55
organization: CERN
66
logo: CERN-logo.jpg
77
description: |
8-
At CERN, the European Organization for Nuclear Research, physicists and engineers are probing the fundamental
9-
structure of the universe. They use the world's largest and most complex scientific instruments to study the
10-
basic constituents of matter – the fundamental particles.
8+
At CERN, the European Organization for Nuclear Research, physicists and engineers are probing the fundamental structure of the universe. They use the world's largest and most complex scientific instruments to study the basic constituents of matter – the fundamental particles.
119
---
1210

1311
{% include gsoc_proposal.ext %}

‎_includes/gsdocs_organization_list.ext

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{% comment %}
2+
This liquid template produces the list of organizations for the year passed as a parameter
3+
{% endcomment %}
4+
5+
{% assign org_collection = 'gsdocs-orgs' %}
6+
7+
<table class="table table-hover table-striped">
8+
<tbody>
9+
10+
{% for org in site[org_collection] %}
11+
{% assign url_tokens = org.url | split: '/' %}
12+
{% assign year_position = url_tokens.size | minus: 2 %}
13+
{% assign org_year = url_tokens[year_position] %}
14+
{% capture org_summary %}{%if org.summary %}{{ org.summary }}{%else%}{{ org.description}}{%endif%}{% endcapture %}
15+
{% assign org_summary = org_summary | strip_newlines | markdownify %}
16+
{% if org_year == include.year %}
17+
<tr>
18+
{% if org.logo %}
19+
<td><img src="/images/{{ org.logo }}" alt="{{ org.organization }}" width="100px"></td>
20+
{% else %}
21+
<td class="text-center" style="vertical-align: middle;">{{ org.organization }}</td>
22+
{% endif %}
23+
<td>{{ org_summary }}</td>
24+
<td><a href="/gsdocs/organizations{{ org.path | remove_first: '_' | remove_first: org_collection | replace: '.md', '.html' }}">List of proposals</a></td>
25+
</tr>
26+
{% endif %}
27+
{% endfor %}
28+
29+
</tbody>
30+
</table>

‎_includes/gsdocs_project.ext

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{% comment %}
2+
Liquid template to display Season of Docs proposals for a given project. To be included in a Markdown page.
3+
Project used for proposal filtering must be defined in the 'project' attribute of the page which includes this template.
4+
Each proposal much have an attribute 'project' in its front-matter than can be a single value or a list.
5+
Project names are not case sensitive.
6+
{% endcomment %}
7+
8+
{% assign url_tokens = page.url | split: '/' %}
9+
{% assign year_position = url_tokens.size | minus: 2 %}
10+
{% assign year = url_tokens[year_position] %}
11+
12+
{:.table .table-hover .table-striped}
13+
14+
{% comment %}
15+
Use the project name as the page title if none has been specified (they are typically identical)
16+
{% endcomment %}
17+
{% capture current_title %}{% if page.title contains "Project_" %}{{ page.project }}{% else %}{{ page.title }}{% endif %}{% endcapture %}
18+
19+
# Season of Docs {{ year }} Projects Related To {{ current_title }}
20+
21+
{{ page.description }}
22+
23+
## Project Proposals
24+
25+
{% for proposal in site.gsdocs-proposals %}
26+
{% assign url_tokens = proposal.url | split: '/' %}
27+
{% assign year_position = url_tokens.size | minus: 2 %}
28+
{% assign proposal_year = url_tokens[year_position] %}
29+
{% if proposal_year == year %}
30+
{% for project in proposal.project %}
31+
{% capture u_proposal_project %}{{ project | upcase }}{% endcapture %}
32+
{% capture u_project %}{{ page.project | upcase }}{% endcapture %}
33+
{% if u_proposal_project == u_project %}
34+
* [ {{ proposal.title }} ]( {{ proposal.url }} )
35+
{% endif %}
36+
{% endfor %}
37+
{% endif %}
38+
{% endfor %}

‎_includes/gsdocs_project_list.ext

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{% comment %}
2+
This liquid template produces the list of projects for the year passed as a parameter
3+
{% endcomment %}
4+
5+
{% assign project_collection = 'gsdocs-projects' %}
6+
7+
<table class="table table-hover table-striped">
8+
<tbody>
9+
10+
{% for project in site[project_collection] %}
11+
{% assign url_tokens = project.url | split: '/' %}
12+
{% assign year_position = url_tokens.size | minus: 2 %}
13+
{% assign project_year = url_tokens[year_position] %}
14+
{% capture project_summary %}{%if project.summary %}{{ project.summary }}{%else%}{{ project.description}}{%endif%}{% endcapture %}
15+
{% assign project_summary = project_summary | strip_newlines | markdownify %}
16+
{% if project_year == include.year %}
17+
<tr>
18+
{% if project.logo %}
19+
<td><img src="/images/{{ project.logo }}" alt="{{ project.project }}" width="100px"></td>
20+
{% else %}
21+
<td class="text-center" style="vertical-align: middle;">{{ project.project }}</td>
22+
{% endif %}
23+
<td>{{ project_summary }}</td>
24+
<td><a href="/gsdocs/projects{{ project.path | remove_first: '_' | remove_first: project_collection | replace: '.md', '.html' }}">List of proposals</a></td>
25+
</tr>
26+
{% endif %}
27+
{% endfor %}
28+
29+
</tbody>
30+
</table>

‎_includes/gsdocs_proposal.ext

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{% comment %}
2+
Liquid template to display Season of Docs proposals for a given organization. To be included in a Markdown page.
3+
Organization is defined by 'organization' attribute in front matter of the parent page (that includes this template).
4+
Organization title is defined by 'title' attribute in front matter of the parent page. It defines the proposal
5+
grouping by organization and is case insensitive.
6+
{% endcomment %}
7+
8+
{% assign url_tokens = page.url | split: '/' %}
9+
{% assign year_position = url_tokens.size | minus: 2 %}
10+
{% assign year = url_tokens[year_position] %}
11+
12+
{:.table .table-hover .table-striped}
13+
14+
# Project Proposals by {{ page.title }} in {{ year }}
15+
16+
{{ page.description }}
17+
18+
## Project List
19+
20+
{% for proposal in site.gsdocs-proposals %}
21+
{% assign url_tokens = proposal.url | split: '/' %}
22+
{% assign year_position = url_tokens.size | minus: 2 %}
23+
{% assign proposal_year = url_tokens[year_position] %}
24+
{% if proposal_year == year %}
25+
{% for organization in proposal.organization %}
26+
{% capture u_proposal_org %}{{ organization | upcase }}{% endcapture %}
27+
{% capture u_org %}{{ page.organization | upcase }}{% endcapture %}
28+
{% if u_proposal_org == u_org %}
29+
* [ {{ proposal.title }} ]( {{ proposal.url }} )
30+
{% endif %}
31+
{% endfor %}
32+
{% endif %}
33+
{% endfor %}

‎_layouts/gsdocs_proposal.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default
3+
---
4+
5+
<div class="blog-header">
6+
<h1 class="blog-title">{{ page.title }}</h1>
7+
</div>
8+
9+
{{ content }}
10+
11+
<h2>Corresponding Project</h2>
12+
<ul>
13+
<li><a href="/gsdocs/projects/{{ page.year }}/project_{{ page.project }}.html">{{ page.project }}</a></li>
14+
</ul>
15+
16+
<h2>Participating Organizations</h2>
17+
<ul>
18+
{% for item in page.organization %}
19+
<li><a href="/gsdocs/organizations/{{ page.year }}/{{ item| downcase}}.html">{{ item }}</a> </li>
20+
{% endfor %}
21+
</ul>

‎gsdocs/2019/mentors.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Summary of Mentors Season of Docs 2019
3+
layout: plain
4+
---
5+
6+
## Full Mentor List (Name, Email, Org)
7+
8+
* Currently empty

‎gsdocs/2019/summary.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Summary of Season of Docs 2019 Projects and Supervisors
3+
layout: plain
4+
year: 2019
5+
---
6+
7+
## Full List of Proposals
8+
9+
{:.table .table-hover .table-striped}
10+
{% assign sorted_proposals = site.gsdocs-proposals | sort: 'title' %}
11+
{% for proposal in sorted_proposals %}{% capture u_proposal_org %}{{ organization | upcase }}{% endcapture %}
12+
{%- assign strings = proposal.url | split: '/' -%}
13+
{%- assign proposal_year = strings[2] | plus: 0 -%}
14+
{%- if proposal_year == page.year %}
15+
| [ {{ proposal.title }} ]( {{ proposal.url }} ) |
16+
{%- endif -%}
17+
{% endfor %}

‎gsoc/2019/mentors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Summary of Mentors GSoC 2019
33
layout: plain
44
---
55

6-
## Full Mentor List (Name, Email, Org)
6+
## Full Mentor List (Name, Email, Org)
77

88
* Roel Aaij [[email protected]](mailto:[email protected]) Nikhef
99
* Xiaocong Ai [[email protected]](mailto:[email protected]) UCB

0 commit comments

Comments
 (0)