Skip to content

Commit

Permalink
Update project page creation tooling to PW40
Browse files Browse the repository at this point in the history
  • Loading branch information
sjh26 committed Nov 17, 2023
1 parent a9d37c9 commit 1454ae7
Show file tree
Hide file tree
Showing 6 changed files with 140 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/project.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Project
description: Issue template to streamline the creation of project pages.
title: "Project: "
labels: ["project", "event:PW39_2023_Montreal"]
labels: ["project", "event:PW40_2024_GranCanaria"]
assignees:
- drouin-simon
- piiq
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Proposal
description: Issue template for creating an issue supporting discussion around a project concept or idea.
title: "Proposal: "
labels: ["proposal", "event:PW39_2023_Montreal"]
labels: ["proposal", "event:PW40_2024_GranCanaria"]
assignees:
- drouin-simon
- piiq
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/project-page-pull-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
id: event_info
run: |
# TODO: Extract event name from "event:NAME" label
event_name="PW39_2023_Montreal"
event_name="PW40_2024_GranCanaria"
echo "name=$event_name" >> $GITHUB_OUTPUT
- uses: actions/checkout@v3
Expand Down
58 changes: 58 additions & 0 deletions PW40_2024_GranCanaria/Projects/Template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: pw40-project

permalink: /:path/

project_title: Write full project title here
category: Uncategorized
presenter_location: Online

key_investigators:
- name: Person Doe
affiliation: University

- name: Person2 Doe2
affiliation: University2
country: Spain
---

# Project Description

<!-- Add a short paragraph describing the project. -->

## Objective

<!-- Describe here WHAT you would like to achieve (what you will have as end result). -->

1. Objective A. Describe **what you plan to achieve** in 1-2 sentences.
1. Objective B. ...
1. Objective C. ...

## Approach and Plan

<!-- Describe here HOW you would like to achieve the objectives stated above. -->

1. Describe specific steps of **what you plan to do** to achieve the above described objectives.
1. ...
1. ...

## Progress and Next Steps

<!-- Update this section as you make progress, describing of what you have ACTUALLY DONE.
If there are specific steps that you could not complete then you can describe them here, too. -->

1. Describe specific steps you **have actually done**.
1. ...
1. ...

# Illustrations

<!-- Add pictures and links to videos that demonstrate what has been accomplished.
![Description of picture](Example2.jpg)
![Some more images](Example2.jpg)
-->

# Background and References

<!-- If you developed any software, include link to the source code repository.
If possible, also add links to sample data, and to any relevant publications. -->
56 changes: 56 additions & 0 deletions PW40_2024_GranCanaria/Projects/Template/README.md.j2
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
layout: pw40-project

permalink: /:path/

project_title: {{ title | to_yaml | regex_replace("\n$|\n\.\.\.\n$", "") }}
category: {{ category | regex_replace("\n$|\n\.\.\.\n$", "") }}
presenter_location: {{ presenter_location | regex_replace("\n$|\n\.\.\.\n$", "") }}

key_investigators:
{% for investigator in investigators %}
- name: {{ investigator.name | to_yaml | regex_replace("\n$|\n\.\.\.\n$", "") }}
affiliation: {{ investigator.affiliation | to_yaml | regex_replace("\n$|\n\.\.\.\n$", "") }}
{%- if investigator.country %}
country: {{ investigator.country | to_yaml | regex_replace("\n$|\n\.\.\.\n$", "") }}
{%- endif %}
{% endfor %}
---

# Project Description

<!-- Add a short paragraph describing the project. -->

{{ description }}

## Objective

<!-- Describe here WHAT you would like to achieve (what you will have as end result). -->

{{ objective }}

## Approach and Plan

<!-- Describe here HOW you would like to achieve the objectives stated above. -->

{{ approach }}

## Progress and Next Steps

<!-- Update this section as you make progress, describing of what you have ACTUALLY DONE.
If there are specific steps that you could not complete then you can describe them here, too. -->

{{ progress }}

# Illustrations

<!-- Add pictures and links to videos that demonstrate what has been accomplished. -->

{{ illustrations }}

# Background and References

<!-- If you developed any software, include link to the source code repository.
If possible, also add links to sample data, and to any relevant publications. -->

{{ background }}
23 changes: 23 additions & 0 deletions _layouts/pw40-project.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default
---

Back to <a href="../../#projects">Projects List</a>

<h1>{{ page.project_title }}</h1>

<h2>Key Investigators</h2>

<ul>
{% if page.key_investigators %}
{% for investigator in page.key_investigators %}
<li>{{ investigator.name }} ({{ investigator.affiliation }}{% if investigator.country %}, {{ investigator.country }}{% endif %})</li>
{% endfor %}
{% endif %}
</ul>

<i>Presenter location: {{page.presenter_location}}</i>

{{ content }}

</div>

0 comments on commit 1454ae7

Please sign in to comment.