Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use CG-DRAFT template #194

Merged
merged 2 commits into from
Jul 3, 2024
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
5 changes: 1 addition & 4 deletions .github/workflows/cd-config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
30 changes: 30 additions & 0 deletions .github/workflows/ci-config.yml
Original file line number Diff line number Diff line change
@@ -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
3 changes: 0 additions & 3 deletions logo.include

This file was deleted.

24 changes: 3 additions & 21 deletions streaming-http-channel-2023.bs
Original file line number Diff line number Diff line change
@@ -1,40 +1,22 @@
<pre class='metadata'>
Title: Solid StreamingHTTPChannel2023
Boilerplate: issues-index no
Local Boilerplate: logo yes
Shortname: solid-streaming-http-channel-2023
Level: 1
Status: w3c/ED
Group: Solid Community Group
Favicon: https://solidproject.org/TR/solid.svg
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
an Editor’s Draft. 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
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.
</pre>

# Introduction # {#introduction}
Expand Down
23 changes: 3 additions & 20 deletions streaming-http-subscription-2021.bs
Original file line number Diff line number Diff line change
@@ -1,38 +1,21 @@
<pre class='metadata'>
Title: Solid StreamingHTTPSubscription2021
Boilerplate: issues-index no
Local Boilerplate: logo yes
Shortname: solid-streaming-http-subscription-2021
Level: 1
Status: w3c/ED
Group: Solid Community Group
Favicon: https://solidproject.org/TR/solid.svg
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
an Editor’s Draft. 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
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.
</pre>

# Introduction # {#introduction}
Expand Down
24 changes: 3 additions & 21 deletions webhook-channel-2023.bs
Original file line number Diff line number Diff line change
@@ -1,41 +1,23 @@
<pre class='metadata'>
Title: Solid WebhookChannel2023
Boilerplate: issues-index no
Local Boilerplate: logo yes
Shortname: solid-webhook-channel-2023
Level: 1
Status: w3c/ED
Group: Solid Community Group
Favicon: https://solidproject.org/TR/solid.svg
Status: CG-DRAFT
Group: solidcg
ED: https://solid.github.io/notifications/webhook-channel-2023
Repository: https://github.com/solid/notifications
Inline Github Issues: title
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
an Editor’s Draft. 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
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.
</pre>

# Introduction # {#introduction}
Expand Down
22 changes: 3 additions & 19 deletions webpush-subscription-2022.bs
Original file line number Diff line number Diff line change
@@ -1,37 +1,21 @@
<pre class='metadata'>
Title: Solid WebPushSubscription2022
Boilerplate: issues-index no
Local Boilerplate: logo yes
Shortname: solid-webpush-subscription-2022
Level: 1
Status: w3c/ED
Group: Solid Community Group
Favicon: https://solidproject.org/TR/solid.svg
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
an Editor’s Draft. 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
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.
</pre>

<div class="note">
Expand Down
Loading