From 3ab306b40956c2dcfc172f8a6e425bd4bc5373be Mon Sep 17 00:00:00 2001 From: Jonathan Niehof Date: Mon, 15 Apr 2024 11:53:53 -0400 Subject: [PATCH 01/10] Initial hack at displaying approved PHEPs --- _data/pheps.yml | 12 ++++++++++++ _includes/phep_table.html | 34 ++++++++++++++++++++++++++++++++++ _pages/pheps.html | 24 ++++++++++++++++++++++++ 3 files changed, 70 insertions(+) create mode 100644 _data/pheps.yml create mode 100644 _includes/phep_table.html create mode 100644 _pages/pheps.html diff --git a/_data/pheps.yml b/_data/pheps.yml new file mode 100644 index 0000000..a828492 --- /dev/null +++ b/_data/pheps.yml @@ -0,0 +1,12 @@ +- Author: Jonathan T. Niehof + Content-Type: text/markdown; charset=UTF-8; variant=CommonMark + Created: 20-Oct-2023 + 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 + Revision: 1 + Status: Draft + Title: PHEP Purpose and Guidelines + Type: Process diff --git a/_includes/phep_table.html b/_includes/phep_table.html new file mode 100644 index 0000000..2306f25 --- /dev/null +++ b/_includes/phep_table.html @@ -0,0 +1,34 @@ +
+ + + + + + + + + + + + {% for phep in {{include.sorted_pheps}} %} + {% if id == 1 and phep.Status == 'Final' or id == 2 and phep.Status != 'Final' %} + + + + + + + + {% endif %} + {% endfor %} + +
NumberTitleStatusTypeRevision
{{ phep.PHEP }} + {{ phep.Title }} + + {{ phep.Status }} + + {{ phep.Type }} + + {{ phep.Revision }} +
+
diff --git a/_pages/pheps.html b/_pages/pheps.html new file mode 100644 index 0000000..2df109c --- /dev/null +++ b/_pages/pheps.html @@ -0,0 +1,24 @@ +--- +layout: page +title: Projects +permalink: /pheps/ +order: 5 +--- +{% assign sorted_pheps = site.data.pheps | sort:'PHEP' %} +

+PyHC Enhancement Proposals are developed via the PyHC standards repository. PHEPs which have gone through the acceptance process, whether finally accepted or rejected, are linked here. +

+

Final

+

+ These PHEPs have been accepted and are currently in force. +

+{% assign id = 1 %} +{% include phep_table.html sorted_pheps=sorted_pheps id=id %} + +

Other

+

+ These PHEPs have been rejected, withdrawn, or replaced, and thus are not currently in force. +

+{% assign id = 2 %} +{% include phep_table.html sorted_pheps=sorted_pheps id=id %} + From 99515cef670856d0c20e9cdcb04844de071eebd2 Mon Sep 17 00:00:00 2001 From: sapols Date: Tue, 16 Apr 2024 16:39:45 -0600 Subject: [PATCH 02/10] Fix conditional logic to display PHEPs in correct table --- _includes/phep_table.html | 77 ++++++++++++++++++++++----------------- _pages/pheps.html | 2 +- 2 files changed, 45 insertions(+), 34 deletions(-) diff --git a/_includes/phep_table.html b/_includes/phep_table.html index 2306f25..8c87674 100644 --- a/_includes/phep_table.html +++ b/_includes/phep_table.html @@ -1,34 +1,45 @@ -
- - - - - - - - - +
+
NumberTitleStatusTypeRevision
+ + + + + + + + + - - {% for phep in {{include.sorted_pheps}} %} - {% if id == 1 and phep.Status == 'Final' or id == 2 and phep.Status != 'Final' %} - - - - - - - - {% endif %} - {% endfor %} - -
NumberTitleStatusTypeRevision
{{ phep.PHEP }} - {{ phep.Title }} - - {{ phep.Status }} - - {{ phep.Type }} - - {{ phep.Revision }} -
-
+ + {% for phep in include.sorted_pheps %} + {% capture phep_row %} + + {{ phep.PHEP }} + + {{ phep.Title }} + + + {{ phep.Status }} + + + {{ phep.Type }} + + + {{ phep.Revision }} + + + {% endcapture %} + + {% if include.id == 1 %} + {% if phep.Status == 'Final' %} + {{ phep_row }} + {% endif %} + {% else %} + {% if phep.Status != 'Final' %} + {{ phep_row }} + {% endif %} + {% endif %} + {% endfor %} + + + diff --git a/_pages/pheps.html b/_pages/pheps.html index 2df109c..e1ecbc4 100644 --- a/_pages/pheps.html +++ b/_pages/pheps.html @@ -1,6 +1,6 @@ --- layout: page -title: Projects +title: PHEPs permalink: /pheps/ order: 5 --- From bb2f3c4c7f6ee6c600f78cef690ff6b2f6658b40 Mon Sep 17 00:00:00 2001 From: sapols Date: Wed, 17 Apr 2024 09:56:21 -0600 Subject: [PATCH 03/10] Move PHEPs page under /docs/ --- _pages/docs.html | 14 ++++++++++++++ _pages/{ => docs}/pheps.html | 4 ++-- 2 files changed, 16 insertions(+), 2 deletions(-) rename _pages/{ => docs}/pheps.html (94%) diff --git a/_pages/docs.html b/_pages/docs.html index 5fc1069..33aeb9e 100644 --- a/_pages/docs.html +++ b/_pages/docs.html @@ -20,6 +20,20 @@
PyHC Standards

+
+
+ +
+
+ PyHC Enhancement Proposals (PHEPs) +
+ Documents that propose new features or processes for PyHC, providing a standardized way for introducing and discussing changes to the community.
+
+
+
+ +
+
diff --git a/_pages/pheps.html b/_pages/docs/pheps.html similarity index 94% rename from _pages/pheps.html rename to _pages/docs/pheps.html index e1ecbc4..d78523e 100644 --- a/_pages/pheps.html +++ b/_pages/docs/pheps.html @@ -1,8 +1,8 @@ --- layout: page title: PHEPs -permalink: /pheps/ -order: 5 +permalink: /docs/pheps/ +exclude: true --- {% assign sorted_pheps = site.data.pheps | sort:'PHEP' %}

From 7b4a112c46a1b8523a3d5af2002ac43b147015c5 Mon Sep 17 00:00:00 2001 From: sapols Date: Wed, 17 Apr 2024 10:44:04 -0600 Subject: [PATCH 04/10] Use escape_once filter to ensure characters are not rendered as HTML --- _includes/phep_table.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_includes/phep_table.html b/_includes/phep_table.html index 8c87674..b9d0a89 100644 --- a/_includes/phep_table.html +++ b/_includes/phep_table.html @@ -14,18 +14,18 @@ {% for phep in include.sorted_pheps %} {% capture phep_row %} - {{ phep.PHEP }} + {{ phep.PHEP | escape_once }} {{ phep.Title }} - {{ phep.Status }} + {{ phep.Status | escape_once }} - {{ phep.Type }} + {{ phep.Type | escape_once }} - {{ phep.Revision }} + {{ phep.Revision | escape_once }} {% endcapture %} From 85c9ec583ae2bf1ab0a417a0bb41913f6f66686d Mon Sep 17 00:00:00 2001 From: sapols Date: Wed, 17 Apr 2024 10:44:46 -0600 Subject: [PATCH 05/10] Change pheps.html to pheps.md --- _pages/docs/{pheps.html => pheps.md} | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) rename _pages/docs/{pheps.html => pheps.md} (78%) diff --git a/_pages/docs/pheps.html b/_pages/docs/pheps.md similarity index 78% rename from _pages/docs/pheps.html rename to _pages/docs/pheps.md index d78523e..a667052 100644 --- a/_pages/docs/pheps.html +++ b/_pages/docs/pheps.md @@ -4,6 +4,9 @@ permalink: /docs/pheps/ exclude: true --- + + + {% assign sorted_pheps = site.data.pheps | sort:'PHEP' %}

PyHC Enhancement Proposals are developed via the PyHC standards repository. PHEPs which have gone through the acceptance process, whether finally accepted or rejected, are linked here. @@ -21,4 +24,3 @@

Other

{% assign id = 2 %} {% include phep_table.html sorted_pheps=sorted_pheps id=id %} - From cb9bf2c2888030be4d1d59a226b917ef9471569f Mon Sep 17 00:00:00 2001 From: sapols Date: Wed, 17 Apr 2024 10:59:28 -0600 Subject: [PATCH 06/10] Add a DOI column --- _includes/phep_table.html | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/_includes/phep_table.html b/_includes/phep_table.html index b9d0a89..a761f0c 100644 --- a/_includes/phep_table.html +++ b/_includes/phep_table.html @@ -7,6 +7,7 @@ Status Type Revision + DOI @@ -27,6 +28,9 @@ {{ phep.Revision | escape_once }} + + {{ phep.DOI }} + {% endcapture %} From 11bad689cd11c89ae338c4103fe8f2c376a682a9 Mon Sep 17 00:00:00 2001 From: sapols Date: Wed, 17 Apr 2024 11:04:07 -0600 Subject: [PATCH 07/10] Add extra whitespace between tables --- _pages/docs/pheps.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_pages/docs/pheps.md b/_pages/docs/pheps.md index a667052..5cca1da 100644 --- a/_pages/docs/pheps.md +++ b/_pages/docs/pheps.md @@ -18,6 +18,8 @@ PyHC Enhancement Proposals are developed via the - +
+
@@ -34,7 +34,7 @@ {% endcapture %} - {% if include.id == 1 %} + {% if include.table_id == 1 %} {% if phep.Status == 'Final' %} {{ phep_row }} {% endif %} diff --git a/_pages/docs/pheps.md b/_pages/docs/pheps.md index 5cca1da..85c6c66 100644 --- a/_pages/docs/pheps.md +++ b/_pages/docs/pheps.md @@ -16,7 +16,7 @@ PyHC Enhancement Proposals are developed via the {% assign id = 2 %} -{% include phep_table.html sorted_pheps=sorted_pheps id=id %} +{% include phep_table.html sorted_pheps=sorted_pheps table_id=id %} From f927cf0a855bd249ebf674fb1929b25fa241e309 Mon Sep 17 00:00:00 2001 From: sapols Date: Wed, 17 Apr 2024 11:15:05 -0600 Subject: [PATCH 09/10] Add whitespace before first table --- _pages/docs/pheps.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_pages/docs/pheps.md b/_pages/docs/pheps.md index 85c6c66..c80b6c6 100644 --- a/_pages/docs/pheps.md +++ b/_pages/docs/pheps.md @@ -11,6 +11,9 @@ exclude: true

PyHC Enhancement Proposals are developed via the PyHC standards repository. PHEPs which have gone through the acceptance process, whether finally accepted or rejected, are linked here.

+ +
+

Final

These PHEPs have been accepted and are currently in force. From 3760a311eab099451fe699cecdefd45c9782fe62 Mon Sep 17 00:00:00 2001 From: Jon Niehof Date: Mon, 20 May 2024 16:30:20 -0400 Subject: [PATCH 10/10] Mark PHEP1 as Final --- _data/pheps.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/_data/pheps.yml b/_data/pheps.yml index a828492..ce398ed 100644 --- a/_data/pheps.yml +++ b/_data/pheps.yml @@ -1,12 +1,15 @@ - Author: Jonathan T. Niehof - Content-Type: text/markdown; charset=UTF-8; variant=CommonMark + 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 + 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: Draft + Status: Final Title: PHEP Purpose and Guidelines Type: Process

Number