Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit f898a29

Browse files
elf-pavlikelf-pavlik
committedJun 22, 2024·
update to new bikeshed-boilerplate
1 parent b19c22f commit f898a29

File tree

6 files changed

+43
-77
lines changed

6 files changed

+43
-77
lines changed
 

‎.github/workflows/cd-config.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,9 @@ jobs:
1818
with:
1919
python-version: '3.10'
2020

21-
- name: Upgrade pip
22-
run: python3 -m pip install --upgrade pip
23-
2421
- name: Install Bikeshed
2522
run: |
26-
python3 -m pip install --upgrade bikeshed
23+
pipx install bikeshed
2724
bikeshed update
2825
2926
- name: Generate HTML

‎.github/workflows/ci-config.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Workflow for verifying bikeshed documents processing
2+
3+
name: Verify processing
4+
on:
5+
# only concerned with gating PRs to the main branch
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v2
15+
16+
- name: Setup Python
17+
uses: actions/setup-python@v3
18+
with:
19+
python-version: '3.10'
20+
21+
- name: Install Bikeshed
22+
run: |
23+
pipx install bikeshed
24+
bikeshed update
25+
26+
- name: Generate HTML
27+
run: for bsdoc in ./*.bs; do bikeshed spec --gh-token=${{ secrets.GITHUB_TOKEN }} $bsdoc; done
28+
29+
- name: Generate SVG
30+
run: for diagram in ./*.mmd; do docker run --rm -v "$PWD:/data" minlag/mermaid-cli -i /data/$diagram; done

‎streaming-http-channel-2023.bs

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,20 @@ Title: Solid StreamingHTTPChannel2023
33
Boilerplate: issues-index no
44
Shortname: solid-streaming-http-channel-2023
55
Level: 1
6-
Status: w3c/CG-DRAFT
7-
Group: Solid Community Group
6+
Status: CG-DRAFT
7+
Group: solidcg
88
ED: https://solid.github.io/notifications/streaming-http-channel-2023
99
Repository: https://github.com/solid/notifications
1010
Inline Github Issues: title
1111
Markup Shorthands: markdown yes
1212
Max ToC Depth: 2
1313
Editor: [elf Pavlik](https://elf-pavlik.hackers4peace.net/)
14+
!Version: 0.1
1415
Abstract:
1516
The [[!Solid.Notifications.Protocol]] defines a set of interaction patterns for agents to receive notification
1617
about changes to resources in a Solid Storage.
1718
1819
This specification defines a channel type that applies these patterns to the Fetch API.
19-
Status Text:
20-
**Version: 0.1**
21-
22-
This section describes the status of this document at the time of its publication.
23-
24-
This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
25-
a Community Group Draft Report. The information in this document is
26-
still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
27-
any feedback, comments, or questions you might have.
28-
29-
Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
30-
document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
31-
to cite this document as other than work in progress.
32-
33-
This document was produced by a group operating under the [W3C Community Contributor License Agreement
34-
(CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
35-
[summary](https://www.w3.org/community/about/process/cla-deed/) is available.
3620
</pre>
3721

3822
# Introduction # {#introduction}

‎streaming-http-subscription-2021.bs

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,19 @@ Title: Solid StreamingHTTPSubscription2021
33
Boilerplate: issues-index no
44
Shortname: solid-streaming-http-subscription-2021
55
Level: 1
6-
Status: w3c/CG-DRAFT
7-
Group: Solid Community Group
6+
Status: CG-DRAFT
7+
Group: solidcg
88
ED: https://solid.github.io/notifications/streaming-http-subscription-2021
99
Repository: https://github.com/solid/notifications
1010
Inline Github Issues: title
1111
Markup Shorthands: markdown yes
1212
Max ToC Depth: 2
1313
Editor: [elf Pavlik](https://elf-pavlik.hackers4peace.net/)
14+
!Version: 0.1
1415
Abstract:
1516
The [[!Solid.Notifications]] defines a set of interaction patterns for agents to establish subscriptions to resources in a Solid Storage.
1617
1718
This specification defines a subscription type that applies these patterns to the Fetch API.
18-
Status Text:
19-
This section describes the status of this document at the time of its publication.
20-
21-
This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
22-
a Community Group Draft Report. The sections that have been incorporated have been reviewed following the
23-
[Solid process](https://github.com/solid/process). However, the information in this document is
24-
still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
25-
any feedback, comments, or questions you might have.
26-
27-
Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
28-
document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
29-
to cite this document as other than work in progress.
30-
31-
This document was produced by a group operating under the [W3C Community Contributor License Agreement
32-
(CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
33-
[summary](https://www.w3.org/community/about/process/cla-deed/) is available.
3419
</pre>
3520

3621
# Introduction # {#introduction}

‎webhook-channel-2023.bs

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,21 @@ Title: Solid WebhookChannel2023
33
Boilerplate: issues-index no
44
Shortname: solid-webhook-channel-2023
55
Level: 1
6-
Status: w3c/CG-DRAFT
7-
Group: Solid Community Group
6+
Status: CG-DRAFT
7+
Group: solidcg
88
ED: https://solid.github.io/notifications/webhook-channel-2023
99
Repository: https://github.com/solid/notifications
1010
Inline Github Issues: title
1111
Markup Shorthands: markdown yes
1212
Max ToC Depth: 2
1313
Editor: Jackson Morgan
1414
Editor: [elf Pavlik](https://elf-pavlik.hackers4peace.net/)
15+
!Version: 0.1
1516
Abstract:
1617
The [[!Solid.Notifications.Protocol]] defines a set of interaction patterns for agents to receive notification
1718
about changes to resources in a Solid Storage.
1819
1920
This specification defines a channel type that applies these patterns to the Webhooks.
20-
Status Text:
21-
**Version: 0.1**
22-
23-
This section describes the status of this document at the time of its publication.
24-
25-
This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
26-
a Community Group Draft Report. The information in this document is
27-
still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
28-
any feedback, comments, or questions you might have.
29-
30-
Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
31-
document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
32-
to cite this document as other than work in progress.
33-
34-
This document was produced by a group operating under the [W3C Community Contributor License Agreement
35-
(CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
36-
[summary](https://www.w3.org/community/about/process/cla-deed/) is available.
3721
</pre>
3822

3923
# Introduction # {#introduction}

‎webpush-subscription-2022.bs

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,19 @@ Title: Solid WebPushSubscription2022
33
Boilerplate: issues-index no
44
Shortname: solid-webpush-subscription-2022
55
Level: 1
6-
Status: w3c/CG-DRAFT
7-
Group: Solid Community Group
6+
Status: CG-DRAFT
7+
Group: solidcg
88
ED: https://solid.github.io/notifications/webpush-subscription-2022
99
Repository: https://github.com/solid/notifications
1010
Inline Github Issues: title
1111
Markup Shorthands: markdown yes
1212
Max ToC Depth: 2
1313
Editor: [Christoph Braun](https://github.com/uvdsl)
14+
!Version: 0.1
1415
Abstract:
1516
The [[!SOLID-NOTIFICATIONS inline]] defines a set of interaction patterns for agents to establish subscriptions to resources in a Solid Storage.
1617
1718
This specification defines a subscription type that applies these patterns to the [[!PUSH-API inline]].
18-
Status Text:
19-
This section describes the status of this document at the time of its publication.
20-
21-
This document was published by the [Solid Community Group](https://www.w3.org/community/solid/) as
22-
a Community Group Draft Report. The information in this document is
23-
still subject to change. You are invited to [contribute](https://github.com/solid/solid-oidc/issues)
24-
any feedback, comments, or questions you might have.
25-
26-
Publication as a Community Group Draft Report does not imply endorsement by the W3C Membership. This is a draft
27-
document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate
28-
to cite this document as other than work in progress.
29-
30-
This document was produced by a group operating under the [W3C Community Contributor License Agreement
31-
(CLA)](https://www.w3.org/community/about/process/cla/). A human-readable
32-
[summary](https://www.w3.org/community/about/process/cla-deed/) is available.
3319
</pre>
3420

3521
<div class="note">

0 commit comments

Comments
 (0)
Please sign in to comment.