Merge pull request #114 from dlemire60/pub-hist-table-includes

Restructure Publication History Page
OpenC2-org · Apr 24, 2024 · 5d9e0ec · 5d9e0ec
2 parents 043cfc5 + 2d75c92
commit 5d9e0ec
Show file tree

Hide file tree

Showing 14 changed files with 340 additions and 862 deletions.
diff --git a/README.md b/README.md
@@ -13,9 +13,10 @@ Contents of this README.md file:
 - [About this website](#about-this-website)
   - [Website Structure](#website-structure)
   - [Maintaining the Website](#maintaining-the-website)
-    - [How to add/remove slides in the carousel on the homepage?](#how-to-addremove-slides-in-the-carousel-on-the-homepage)
-    - [How to update the news timeline in "OpenC2 in the news" page?](#how-to-update-the-news-timeline-in-openc2-in-the-news-page)
-    - [How to update the Frequently Asked Questions (FAQ) page?](#how-to-update-the-frequently-asked-questions-faq-page)
+    - [How to add/remove slides in the carousel on the homepage](#how-to-addremove-slides-in-the-carousel-on-the-homepage)
+    - [How to update the news timeline in "OpenC2 in the news" page](#how-to-update-the-news-timeline-in-openc2-in-the-news-page)
+    - [How to update the Frequently Asked Questions (FAQ) page](#how-to-update-the-frequently-asked-questions-faq-page)
+    - [How To Update the Publication History Page](#how-to-update-the-publication-history-page)
   - [How to run the website on your local computer](#how-to-run-the-website-on-your-local-computer)
   - [Contributing](#contributing)
 
@@ -69,6 +70,10 @@ here:
 |       -- defense-cybertime.md      # Markdown imported in "OpenC2 for Defense in Cyber-Relevant Time" paragraph in index.html
 |       -- openc2-help.md            # Markdown imported in "How can OpenC2 help?" paragraph in index.html
 |       -- vision.md                 # Markdown imported in "Vision" paragraph in index.html
++-- pub-histories
+|   -- ap-dev-cn-hist-table.md       # Markdown file with publication history for AP Development Committee Note.
+|   -- arch-hist-table.md            # Markdown file with publication history for Architecture Specifications.
+|   -- ...                           # Markdown files with publication history for other TC work products.
 +-- vectors
 |   -- attackspeed.ai                # Original illustration for the picture used in "Current CyberDefense".
 |   -- automate.ai                   # Original illustration for the picture used in "OpenC2 for Defense in Cyber-Relevant Time".
@@ -89,14 +94,15 @@ here:
 -- opensource.html                   # Opensource Software
 -- otc.html                          # OASIS OpenC2 Technical Committee
 -- otherdocumentation.html           # Other Documentation
+-- pubhist.html                      # Detailed publication histories of TC work products; imports from pub-histories folder
 -- README.md                         # Documentation on how to use/contribute to this website
 -- specifications.html               # Specifications
 
 ```
 
 ## Maintaining the Website
 
-### How to add/remove slides in the carousel on the homepage?
+### How to add/remove slides in the carousel on the homepage
 ```index.html``` is the homepage and it uses [Bootstrap
 Carousel](https://getbootstrap.com/docs/4.0/components/carousel).
 Please refer to it's documentation to learn more about it.
@@ -124,7 +130,7 @@ Open ```index.html``` and add the HTML code inside the
 To remove unwanted slides, delete the HTML code and content file
 for the unused slide.
 
-### How to update the news timeline in "OpenC2 in the news" page?
+### How to update the news timeline in "OpenC2 in the news" page
 The `_news` folder contains the collection of individual news
 item files, stored one per file in Markdown format. The file
 structure is simple:
@@ -191,7 +197,7 @@ Notes:
 
 
 
-### How to update the Frequently Asked Questions (FAQ) page?
+### How to update the Frequently Asked Questions (FAQ) page
 The `_faqs` folder contains the collection of FAQs, stored one
 per file in Markdown format. The file structure is simple:
 
@@ -240,6 +246,34 @@ Notes:
 2) Complete URLs should be employed when placing web links in FAQ
    responses; relative URLs within the website should be avoided.
 
+
+### How To Update the Publication History Page
+
+The publication histories are delivered via an HTML page (`pubhist.html`). Each
+TC work product has a section in the page which includes the title, a copy of
+the document's abstract, and a history for each publication stage showing
+version, publication identifier, and date. The publication history tables are
+contained in individual markdown files, one per work product, which are imported
+by `pubhist.html`. This simplifies maintenance by eliminating the need to edit
+an HTML table, however the imported Markdown tables use HTML anchors to create
+web links that open in new tabs / windows (i.e., `target="_blank"`).
+
+ - **To add a publication event to an existing work product**: locate and edit the
+   corresponding history table file in the `pub-histories` folder.
+ - **To add a new work product**:
+   - Update `pubhist.html`: Create a new section in the document for the new
+     work product (e.g., by copy / paste / edit of an existing section). If
+     copying an existing section, update the capture / import statement (`{%
+     capture t10 %}...`) by incrementing the variable number and modifying the
+     imported filename to reflect the new work product.
+   - Create a new import history table file under `pub-histories/`. This can be
+     done by copy / rename / edit of an existing history table file. The
+     filename needs to match the name used in the new  `pubhist.html` section. 
+
+The first line of the publication history table always refers to the current
+work-in-progress version of the work product and should link to the working
+branch of the work product's OASIS TC repository on GitHub.
+
 ## How to run the website on your local computer
 
 - Make sure to install [Jekyll](https://jekyllrb.com/) on your

diff --git a/assets/css/style.css b/assets/css/style.css
@@ -994,4 +994,18 @@ table th {
 body {
   font-family: "Open Sans", arial, sans-serif;
   line-height: 1.5;
-}
+}
+
+/* ============== EXPERIMENTAL============== */
+/* Add styles to adjust for the fixed header */ 
+/* This fixes ToC jumps to show doc titles   */
+/* source: https://www.geeksforgeeks.org/how-to-set-offset-an-html-anchor-element-to-adjust-fixed-header-in-css/, option 1  */ 
+   #target-element { 
+    display: block; 
+    position: relative; 
+    top: -80px; 
+
+    /* Replace with the height of your fixed header */ 
+    visibility: hidden; 
+} 
+
diff --git a/pub-histories/ap-dev-cn-hist-table.md b/pub-histories/ap-dev-cn-hist-table.md
@@ -0,0 +1,4 @@
+| **Version** |                **Approval Level**               | **Publication Date** |
+|:-----------:|:-----------------------------------------------:|:--------------------:|
+|   v1.0 WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-cn-apdev/tree/working">Working Meeting: 8 Nov 2023</a> |      10 Nov 2023     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/cn-appdev/v1.0/cn01/cn-appdev-v1.0-cn01.html">CN01</a> |    17 January 2024   |
diff --git a/pub-histories/arch-hist-table.md b/pub-histories/arch-hist-table.md
@@ -0,0 +1,5 @@
+| **Version** | **Approval Level** | **Publication Date** |
+|:---:|:---:|:---:|
+| v1.0 WIP | <a href="https://github.com/oasis-tcs/openc2-oc2arch/tree/working" target="_blank">Working meeting: 11 May 2022</a> | 11 May 2022 |
+| v1.0 | [CS01](https://github.com/oasis-tcs/openc2-oc2arch/blob/working/oc2arch-v1.0.md) | 30 September 2022 |
+| v1.0 | [CSD 01](https://docs.oasis-open.org/openc2/oc2arch/v1.0/cs01/oc2arch-v1.0-cs01.html) | 18 May 2022 |
diff --git a/pub-histories/https-hist-table.md b/pub-histories/https-hist-table.md
@@ -0,0 +1,11 @@
+| **Version** |                       **Approval Level**                      | **Publication Date** |
+|:-----------:|:-------------------------------------------------------------:|:--------------------:|
+|   v1.1 WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-impl-https/tree/working">Working Meeting: 8 Septenber 2021</a> |   8 September 2021   |
+|     v1.1    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.1/cs01/open-impl-https-v1.1-cs01.html">CS 01</a> |   30 November 2021   |
+|     v1.1    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.1/csd01/open-impl-https-v1.1-csd01.html">CSD 01</a> (public review) |   15 September 2021  |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.0/open-impl-https-v1.0.html">CS 01</a> |     11 July 2019     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.0/csprd03/open-impl-https-v1.0-csprd03.html">CSD 05 / PRD 03</a> |      21 May 2019     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.0/csprd02/open-impl-https-v1.0-csprd02.html">CSD 04 / PRD 02</a> |     04 April 2019    |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.0/csprd01/open-impl-https-v1.0-csprd01.html">CSD 03 / PRD 01</a> |    17 October 2018   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.0/csd02/open-impl-https-v1.0-csd02.html">CSD 02</a> |    04 October 2018   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/open-impl-https/v1.0/csd01/open-impl-https-v1.0-csd01.html">CSD 01</a> |    23 August 2018    |
diff --git a/pub-histories/jadn-hist-table.md b/pub-histories/jadn-hist-table.md
@@ -0,0 +1,6 @@
+| **Version** |                     **Approval Level**                    | **Publication Date** |
+|:-----------:|:---------------------------------------------------------:|:--------------------:|
+|   v1.X WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-jadn/tree/working/" >Working Meeting: 16 June 2021</a> |     16 June 2021     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/jadn/v1.0/cs01/jadn-v1.0-cs01.html" >CS 01</a> |    17 August 2021    |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/jadn/v1.0/csd02/jadn-v1.0-csd02.html" >CSD 02</a> (public review) |     16 June 2021     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/jadn/v1.0/csd01/jadn-v1.0-csd01.html" >CSD 01</a> (public review) |    21 October 2020   |
diff --git a/pub-histories/jadn-im-cn-hist-table.md b/pub-histories/jadn-im-cn-hist-table.md
@@ -0,0 +1,5 @@
+| **Version** |                     **Approval Level**                     | **Publication Date** |
+|:-----------:|:----------------------------------------------------------:|:--------------------:|
+|   v1.X WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-jadn-im/tree/working/" >Working Meeting: 12 April 2023</a> |     12 April 2023    |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/imjadn/v1.0/imjadn-v1.0.html" >CN 01</a> |     19 April 2023    |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/imjadn/v1.0/cnd01/imjadn-v1.0-cnd01.html" >CND 01</a> |    18 January 2023   |
diff --git a/pub-histories/lang-hist-table.md b/pub-histories/lang-hist-table.md
@@ -0,0 +1,15 @@
+| **Version** | **Approval Level** | **Publication Date** |
+|:---:|:---:|:---:|
+| v2.0 WIP | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-oc2ls/tree/working/">Working Meeting: 4 January 2023</a> | 22 September 2021 |
+| v2.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v2.0/csd01/oc2ls-v2.0-csd01.html">CSD 01</a> | 16 November 2022 |
+| v1.1 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.1/csd01/oc2ls-v1.1-csd01.html" >CSD 01</a>  | 18 August 2021 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/cs02/oc2ls-v1.0-cs02.html">CS 02</a>  | 24 November 2019 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/cs01/oc2ls-v1.0-cs01.html">CS 01</a>  | 11 July 2019 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csprd02/oc2ls-v1.0-csprd02.html">CSD 08 / PRD 02</a>  | 04 April 2019 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csprd01/oc2ls-v1.0-csprd01.html">CSD 07 / PRD 01</a>  | 17 October 2018 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csd06/oc2ls-v1.0-csd06.html">CSD 06</a> | 17 October 2018 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csd05/oc2ls-v1.0-csd05.html">CSD 05</a>  | 20 July 2018 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csd04/oc2ls-v1.0-csd04.html">CSD 04</a>  | 31 May 2018 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csd03/oc2ls-v1.0-csd03.html">CSD 03</a>  | 03 April 2018 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csd02/oc2ls-v1.0-csd02.html">CSD 02</a>  | 14 February 2018 |
+| v1.0 | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2ls/v1.0/csd01/oc2ls-v1.0-csd01.html">CSD 01</a>  | 14 November 2017 |
diff --git a/pub-histories/mqtt-hist-table.md b/pub-histories/mqtt-hist-table.md
@@ -0,0 +1,8 @@
+| **Version** |                      **Approval Level**                      | **Publication Date** |
+|:-----------:|:------------------------------------------------------------:|:--------------------:|
+|   v1.0 WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-transf-mqtt/tree/working/" >Working Meeting: 13 October 2021</a> |    13 October 2021   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/transf-mqtt/v1.0/cs01/transf-mqtt-v1.0-cs01.html" >CS 01</a> |   19 November 2021   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/transf-mqtt/v1.0/csd04/transf-mqtt-v1.0-csd04.html" >CSD 04</a> |    18 August 2021    |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/transf-mqtt/v1.0/csd03/transf-mqtt-v1.0-csd03.html" >CSD 03</a> |   17 February 2021   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/transf-mqtt/v1.0/csd02/transf-mqtt-v1.0-csd02.html" >CSD 02</a> |   24 September 2020  |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/transf-mqtt/v1.0/csd01/transf-mqtt-v1.0-csd01.html" >CSD 01</a> |     07 July 2020     |
diff --git a/pub-histories/pace-hist-table.md b/pub-histories/pace-hist-table.md
@@ -0,0 +1,3 @@
+| **Version** |                       **Approval Level**                      | **Publication Date** |
+|:-----------:|:-------------------------------------------------------------:|:--------------------:|
+|   v1.0 WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-ap-pac/tree/working/">Working Meeting: 8 Septenber 2021</a> |   18 May 2022   |
diff --git a/pub-histories/pf-hist-table.md b/pub-histories/pf-hist-table.md
@@ -0,0 +1,4 @@
+| **Version** |                       **Approval Level**                      | **Publication Date** |
+|:-----------:|:-------------------------------------------------------------:|:--------------------:|
+|   v1.0 WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-ap-pf/tree/working/">Working Meeting: 8 Septenber 2021</a> |   8 September 2021   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/ap-pf/v1.0/csd01/ap-pf-v1.0-csd01.html">CSD 01</a> |     21 July 2021     |
diff --git a/pub-histories/slpf-hist-table.md b/pub-histories/slpf-hist-table.md
@@ -0,0 +1,10 @@
+| **Version** |              **Approval Level**             | **Publication Date** |
+|:-----------:|:-------------------------------------------:|:--------------------:|
+|   v1.x WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-apsc-stateless-packet-filter/tree/working/">16 October 2020</a> |    16 October 2020   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/oc2slpf-v1.0.html">CS 01</a> |     11 July 2019     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/csprd03/oc2slpf-v1.0-csprd03.html">CSD 06 / PRD 03</a> |      31 May 2019     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/csprd02/oc2slpf-v1.0-csprd02.html">CSD 05 / PRD 02</a> |     04 April 2019    |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/csprd01/oc2slpf-v1.0-csprd01.html">CSD 04 / PRD 01</a> |    17 October 2018   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/csd03/oc2slpf-v1.0-csd03.html">CSD 03</a> |    04 October 2018   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/csd02/oc2slpf-v1.0-csd02.html">CSD 02</a> |     20 July 2018     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/oc2slpf/v1.0/csd01/oc2slpf-v1.0-csd01.html">CSD 01</a> |      31 May 2018     |
diff --git a/pub-histories/th-hist-table.md b/pub-histories/th-hist-table.md
@@ -0,0 +1,5 @@
+| **Version** |                       **Approval Level**                      | **Publication Date** |
+|:-----------:|:-------------------------------------------------------------:|:--------------------:|
+|   v1.0 WIP  | <a rel="noopener noreferrer" target="_blank" href="https://github.com/oasis-tcs/openc2-ap-hunt/tree/working/">Working Meeting: 5 December 2023</a> |   5 December 2023   |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/ap-hunt/v1.0/csd02/ap-hunt-v1.0-csd02.html">CSD 02</a> |     21 February 2024     |
+|     v1.0    | <a rel="noopener noreferrer" target="_blank" href="https://docs.oasis-open.org/openc2/ap-hunt/v1.0/csd01/ap-hunt-v1.0-csd01.html">CSD 01</a> |     20 September 2023     |