Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions _data/pheps.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
- Author: Jonathan T. Niehof <jtniehof@gmail.com> <https://orcid.org/0000-0001-6286-5809>
Content-Type: text/markdown; charset="UTF-8"; variant="CommonMark"
Created: 20-Oct-2023
DOI: 10.5281/zenodo.10988007
Discussions-To: https://github.com/heliophysicsPy/standards/pull/22
Filename: phep-0001.md
PHEP: 1
Post-History: 24-Oct-2023, 31-Oct-2023, 09-Nov-2023, 27-Nov-2023, 06-Dec-2023, 14-Dec-2023,
07-Feb-2024, 28-Feb-2024, 13-Mar-2024, 20-May-2024
Resolution: https://docs.google.com/document/d/1htbibknl1Npv1hQ1O4L22RKO_s8uc9dZT1iTJ49nMJg/edit#heading=h.a0b498f5euue,
https://docs.google.com/document/d/1RNGKHSf1S562WmDhCdYAAy3wG2tl6LT3-KBFYmRXTnA/edit
Revision: 1
Status: Final
Title: PHEP Purpose and Guidelines
Type: Process
49 changes: 49 additions & 0 deletions _includes/phep_table.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<div class="tab-pane fade show active" id="table{{ include.table_id }}">
<table class="table table-striped" id="dataTable{{ include.table_id }}">
<thead>
<tr>
<th scope="col">Number</th>
<th scope="col">Title</th>
<th scope="col">Status</th>
<th scope="col">Type</th>
<th scope="col">Revision</th>
<th scope="col">DOI</th>
</tr>
</thead>

<tbody>
{% for phep in include.sorted_pheps %}
{% capture phep_row %}
<tr>
<th scope="row">{{ phep.PHEP | escape_once }}</th>
<td>
<a href="https://github.com/heliophysicsPy/standards/blob/main/pheps/{{ phep.Filename }}">{{ phep.Title }}</a>
</td>
<td>
{{ phep.Status | escape_once }}
</td>
<td>
{{ phep.Type | escape_once }}
</td>
<td>
{{ phep.Revision | escape_once }}
</td>
<td>
<a href="https://doi.org/{{ phep.DOI }}">{{ phep.DOI }}</a>
</td>
</tr>
{% endcapture %}

{% if include.table_id == 1 %}
{% if phep.Status == 'Final' %}
{{ phep_row }}
{% endif %}
{% else %}
{% if phep.Status != 'Final' %}
{{ phep_row }}
{% endif %}
{% endif %}
{% endfor %}
</tbody>
</table>
</div>
14 changes: 14 additions & 0 deletions _pages/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@ <h5 class="mt-0">PyHC Standards</h5>

<br>

<div class="container mb-2">
<div class="media">
<a href="{{ site.baseurl }}/docs/pheps/"><i class="fas fa-book fa-2x mr-3"></i></a>
<div class="media-body">
<h5 class="mt-0">
<a href="{{ site.baseurl }}/docs/pheps">PyHC Enhancement Proposals (PHEPs)</a>
</h5>
Documents that propose new features or processes for PyHC, providing a standardized way for introducing and discussing changes to the community.<br>
</div>
</div>
</div>

<br>

<div class="container mb-2">
<div class="media">
<a href="{{ site.baseurl }}/docs/adding_a_project/"><i class="fas fa-book fa-2x mr-3"></i></a>
Expand Down
31 changes: 31 additions & 0 deletions _pages/docs/pheps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
layout: page
title: PHEPs
permalink: /docs/pheps/
exclude: true
---
<!-- Temp hack to add "No data available in table" to empty tables with JavaScript (can remove once both tables have entries) -->
<script type="text/javascript" src="../../js/projects.js" class="init"></script>

{% assign sorted_pheps = site.data.pheps | sort:'PHEP' %}
<p>
PyHC Enhancement Proposals are developed via the <a href="https://github.com/heliophysicsPy/standards/">PyHC standards repository</a>. PHEPs which have gone through the acceptance process, whether finally accepted or rejected, are linked here.
</p>

<br>

<h3>Final</h3>
<p>
These PHEPs have been accepted and are currently in force.
</p>
{% assign id = 1 %}
{% include phep_table.html sorted_pheps=sorted_pheps table_id=id %}

<br>

<h3>Other</h3>
<p>
These PHEPs have been rejected, withdrawn, or replaced, and thus are not currently in force.
</p>
{% assign id = 2 %}
{% include phep_table.html sorted_pheps=sorted_pheps table_id=id %}