From b19c22fc5b466570742a72f59c7394a4f2a23ab7 Mon Sep 17 00:00:00 2001 From: elf Pavlik Date: Mon, 17 Jun 2024 07:44:26 -0600 Subject: [PATCH 1/2] use CG-DRAFT template --- logo.include | 3 --- streaming-http-channel-2023.bs | 8 +++----- streaming-http-subscription-2021.bs | 8 +++----- webhook-channel-2023.bs | 8 +++----- webpush-subscription-2022.bs | 8 +++----- 5 files changed, 12 insertions(+), 23 deletions(-) delete mode 100644 logo.include diff --git a/logo.include b/logo.include deleted file mode 100644 index c11163e..0000000 --- a/logo.include +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/streaming-http-channel-2023.bs b/streaming-http-channel-2023.bs index 9bc5b4b..5532d9b 100644 --- a/streaming-http-channel-2023.bs +++ b/streaming-http-channel-2023.bs @@ -1,12 +1,10 @@ 
 Title: Solid StreamingHTTPChannel2023
 Boilerplate: issues-index no
-Local Boilerplate: logo yes
 Shortname: solid-streaming-http-channel-2023
 Level: 1
-Status: w3c/ED
+Status: w3c/CG-DRAFT
 Group: Solid Community Group
-Favicon: https://solidproject.org/TR/solid.svg
 ED: https://solid.github.io/notifications/streaming-http-channel-2023
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
@@ -24,11 +22,11 @@ Status Text:
   This section describes the status of this document at the time of its publication.
 
   This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  an Editor’s Draft. The information in this document is
+  a Community Group Draft Report. The information in this document is
   still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
   any feedback, comments, or questions you might have.
 
-  Publication as an Editor’s Draft does not imply endorsement by the W3C Membership. This is a draft
+  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
   document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
   to cite this document as other than work in progress.
 
diff --git a/streaming-http-subscription-2021.bs b/streaming-http-subscription-2021.bs
index 22c03c8..d29d287 100644
--- a/streaming-http-subscription-2021.bs
+++ b/streaming-http-subscription-2021.bs
@@ -1,12 +1,10 @@
 
 Title: Solid StreamingHTTPSubscription2021
 Boilerplate: issues-index no
-Local Boilerplate: logo yes
 Shortname: solid-streaming-http-subscription-2021
 Level: 1
-Status: w3c/ED
+Status: w3c/CG-DRAFT
 Group: Solid Community Group
-Favicon: https://solidproject.org/TR/solid.svg
 ED: https://solid.github.io/notifications/streaming-http-subscription-2021
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
@@ -21,12 +19,12 @@ Status Text:
   This section describes the status of this document at the time of its publication.
 
   This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  an Editor’s Draft. The sections that have been incorporated have been reviewed following the
+  a Community Group Draft Report. The sections that have been incorporated have been reviewed following the
   [Solid process](https://github.com/solid/process). However, the information in this document is
   still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
   any feedback, comments, or questions you might have.
 
-  Publication as an Editor’s Draft does not imply endorsement by the W3C Membership. This is a draft
+  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
   document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
   to cite this document as other than work in progress.
 
diff --git a/webhook-channel-2023.bs b/webhook-channel-2023.bs
index 34d9ccb..17729b4 100644
--- a/webhook-channel-2023.bs
+++ b/webhook-channel-2023.bs
@@ -1,12 +1,10 @@
 
 Title: Solid WebhookChannel2023
 Boilerplate: issues-index no
-Local Boilerplate: logo yes
 Shortname: solid-webhook-channel-2023
 Level: 1
-Status: w3c/ED
+Status: w3c/CG-DRAFT
 Group: Solid Community Group
-Favicon: https://solidproject.org/TR/solid.svg
 ED: https://solid.github.io/notifications/webhook-channel-2023
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
@@ -25,11 +23,11 @@ Status Text:
   This section describes the status of this document at the time of its publication.
 
   This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  an Editor’s Draft. The information in this document is
+  a Community Group Draft Report. The information in this document is
   still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
   any feedback, comments, or questions you might have.
 
-  Publication as an Editor’s Draft does not imply endorsement by the W3C Membership. This is a draft
+  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
   document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
   to cite this document as other than work in progress.
 
diff --git a/webpush-subscription-2022.bs b/webpush-subscription-2022.bs
index a90391c..562729d 100644
--- a/webpush-subscription-2022.bs
+++ b/webpush-subscription-2022.bs
@@ -1,12 +1,10 @@
 
 Title: Solid WebPushSubscription2022
 Boilerplate: issues-index no
-Local Boilerplate: logo yes
 Shortname: solid-webpush-subscription-2022
 Level: 1
-Status: w3c/ED
+Status: w3c/CG-DRAFT
 Group: Solid Community Group
-Favicon: https://solidproject.org/TR/solid.svg
 ED: https://solid.github.io/notifications/webpush-subscription-2022
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
@@ -21,11 +19,11 @@ Status Text:
   This section describes the status of this document at the time of its publication.
 
   This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  an Editor’s Draft. The information in this document is
+  a Community Group Draft Report. The information in this document is
   still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
   any feedback, comments, or questions you might have.
 
-  Publication as an Editor’s Draft does not imply endorsement by the W3C Membership. This is a draft
+  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
   document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
   to cite this document as other than work in progress.
 

From f898a29f243cea9c3542b536362074bbe0ce74ed Mon Sep 17 00:00:00 2001
From: elf Pavlik 
Date: Sat, 22 Jun 2024 09:39:44 -0600
Subject: [PATCH 2/2] update to new bikeshed-boilerplate

---
 .github/workflows/cd-config.yml     |  5 +----
 .github/workflows/ci-config.yml     | 30 +++++++++++++++++++++++++++++
 streaming-http-channel-2023.bs      | 22 +++------------------
 streaming-http-subscription-2021.bs | 21 +++-----------------
 webhook-channel-2023.bs             | 22 +++------------------
 webpush-subscription-2022.bs        | 20 +++----------------
 6 files changed, 43 insertions(+), 77 deletions(-)
 create mode 100644 .github/workflows/ci-config.yml

diff --git a/.github/workflows/cd-config.yml b/.github/workflows/cd-config.yml
index 6e24a36..976a963 100644
--- a/.github/workflows/cd-config.yml
+++ b/.github/workflows/cd-config.yml
@@ -18,12 +18,9 @@ jobs:
         with:
           python-version: '3.10'
 
-      - name: Upgrade pip
-        run: python3 -m pip install --upgrade pip
-
       - name: Install Bikeshed
         run: |
-          python3 -m pip install --upgrade bikeshed
+          pipx install bikeshed
           bikeshed update
 
       - name: Generate HTML
diff --git a/.github/workflows/ci-config.yml b/.github/workflows/ci-config.yml
new file mode 100644
index 0000000..6db43e6
--- /dev/null
+++ b/.github/workflows/ci-config.yml
@@ -0,0 +1,30 @@
+# Workflow for verifying bikeshed documents processing
+
+name: Verify processing
+on:
+  # only concerned with gating PRs to the main branch
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.10'
+
+      - name: Install Bikeshed
+        run: |
+          pipx install bikeshed
+          bikeshed update
+
+      - name: Generate HTML
+        run: for bsdoc in ./*.bs; do bikeshed spec --gh-token=${{ secrets.GITHUB_TOKEN }} $bsdoc; done
+
+      - name: Generate SVG
+        run: for diagram in ./*.mmd; do docker run --rm -v "$PWD:/data" minlag/mermaid-cli -i /data/$diagram; done
diff --git a/streaming-http-channel-2023.bs b/streaming-http-channel-2023.bs
index 5532d9b..68e30f7 100644
--- a/streaming-http-channel-2023.bs
+++ b/streaming-http-channel-2023.bs
@@ -3,36 +3,20 @@ Title: Solid StreamingHTTPChannel2023
 Boilerplate: issues-index no
 Shortname: solid-streaming-http-channel-2023
 Level: 1
-Status: w3c/CG-DRAFT
-Group: Solid Community Group
+Status: CG-DRAFT
+Group: solidcg
 ED: https://solid.github.io/notifications/streaming-http-channel-2023
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
 Markup Shorthands: markdown yes
 Max ToC Depth: 2
 Editor: [elf Pavlik](https://elf-pavlik.hackers4peace.net/)
+!Version: 0.1
 Abstract:
   The [[!Solid.Notifications.Protocol]] defines a set of interaction patterns for agents to receive notification
   about changes to resources in a Solid Storage.
 
   This specification defines a channel type that applies these patterns to the Fetch API.
-Status Text:
-  **Version: 0.1**
-  
-  This section describes the status of this document at the time of its publication.
-
-  This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  a Community Group Draft Report. The information in this document is
-  still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
-  any feedback, comments, or questions you might have.
-
-  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
-  document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
-  to cite this document as other than work in progress.
-
-  This document was produced by a group operating under the [W3C Community Contributor License Agreement
-  (CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
-  [summary](https://www.w3.org/community/about/process/cla-deed/) is available.
 

 
 # Introduction # {#introduction}
diff --git a/streaming-http-subscription-2021.bs b/streaming-http-subscription-2021.bs
index d29d287..fd2d3fb 100644
--- a/streaming-http-subscription-2021.bs
+++ b/streaming-http-subscription-2021.bs
@@ -3,34 +3,19 @@ Title: Solid StreamingHTTPSubscription2021
 Boilerplate: issues-index no
 Shortname: solid-streaming-http-subscription-2021
 Level: 1
-Status: w3c/CG-DRAFT
-Group: Solid Community Group
+Status: CG-DRAFT
+Group: solidcg
 ED: https://solid.github.io/notifications/streaming-http-subscription-2021
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
 Markup Shorthands: markdown yes
 Max ToC Depth: 2
 Editor: [elf Pavlik](https://elf-pavlik.hackers4peace.net/)
+!Version: 0.1
 Abstract:
   The [[!Solid.Notifications]] defines a set of interaction patterns for agents to establish subscriptions to resources in a Solid Storage.
 
   This specification defines a subscription type that applies these patterns to the Fetch API.
-Status Text:
-  This section describes the status of this document at the time of its publication.
-
-  This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  a Community Group Draft Report. The sections that have been incorporated have been reviewed following the
-  [Solid process](https://github.com/solid/process). However, the information in this document is
-  still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
-  any feedback, comments, or questions you might have.
-
-  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
-  document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
-  to cite this document as other than work in progress.
-
-  This document was produced by a group operating under the [W3C Community Contributor License Agreement
-  (CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
-  [summary](https://www.w3.org/community/about/process/cla-deed/) is available.
 

 
 # Introduction # {#introduction}
diff --git a/webhook-channel-2023.bs b/webhook-channel-2023.bs
index 17729b4..7940696 100644
--- a/webhook-channel-2023.bs
+++ b/webhook-channel-2023.bs
@@ -3,8 +3,8 @@ Title: Solid WebhookChannel2023
 Boilerplate: issues-index no
 Shortname: solid-webhook-channel-2023
 Level: 1
-Status: w3c/CG-DRAFT
-Group: Solid Community Group
+Status: CG-DRAFT
+Group: solidcg
 ED: https://solid.github.io/notifications/webhook-channel-2023
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
@@ -12,28 +12,12 @@ Markup Shorthands: markdown yes
 Max ToC Depth: 2
 Editor: Jackson Morgan
 Editor: [elf Pavlik](https://elf-pavlik.hackers4peace.net/)
+!Version: 0.1
 Abstract:
   The [[!Solid.Notifications.Protocol]] defines a set of interaction patterns for agents to receive notification
   about changes to resources in a Solid Storage.
 
   This specification defines a channel type that applies these patterns to the Webhooks.
-Status Text:
-  **Version: 0.1**
-  
-  This section describes the status of this document at the time of its publication.
-
-  This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  a Community Group Draft Report. The information in this document is
-  still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
-  any feedback, comments, or questions you might have.
-
-  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
-  document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
-  to cite this document as other than work in progress.
-
-  This document was produced by a group operating under the [W3C Community Contributor License Agreement
-  (CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
-  [summary](https://www.w3.org/community/about/process/cla-deed/) is available.
 

 
 # Introduction # {#introduction}
diff --git a/webpush-subscription-2022.bs b/webpush-subscription-2022.bs
index 562729d..a703863 100644
--- a/webpush-subscription-2022.bs
+++ b/webpush-subscription-2022.bs
@@ -3,33 +3,19 @@ Title: Solid WebPushSubscription2022
 Boilerplate: issues-index no
 Shortname: solid-webpush-subscription-2022
 Level: 1
-Status: w3c/CG-DRAFT
-Group: Solid Community Group
+Status: CG-DRAFT
+Group: solidcg
 ED: https://solid.github.io/notifications/webpush-subscription-2022
 Repository: https://github.com/solid/notifications
 Inline Github Issues: title
 Markup Shorthands: markdown yes
 Max ToC Depth: 2
 Editor: [Christoph Braun](https://github.com/uvdsl)
+!Version: 0.1
 Abstract:
   The [[!SOLID-NOTIFICATIONS inline]] defines a set of interaction patterns for agents to establish subscriptions to resources in a Solid Storage.
 
   This specification defines a subscription type that applies these patterns to the [[!PUSH-API inline]].
-Status Text:
-  This section describes the status of this document at the time of its publication.
-
-  This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
-  a Community Group Draft Report. The information in this document is
-  still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
-  any feedback, comments, or questions you might have.
-
-  Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
-  document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
-  to cite this document as other than work in progress.
-
-  This document was produced by a group operating under the [W3C Community Contributor License Agreement
-  (CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
-  [summary](https://www.w3.org/community/about/process/cla-deed/) is available.