Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.

Commit ac16238

Browse files
committed
feat: Added initial bikeshed base spec file, added GitHub action to build and publish the spec
1 parent 7052448 commit ac16238

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

.github/workflows/build.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Build HTML and publish it to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-python@v3
14+
with:
15+
python-version: '3.10'
16+
- run: python3 -m pip install --upgrade pip
17+
- run: python3 -m pip install --upgrade bikeshed && bikeshed update
18+
- run: mkdir public
19+
- run: bikeshed spec index.bs public/index.html
20+
- uses: peaceiris/actions-gh-pages@v3
21+
with:
22+
github_token: ${{ secrets.GITHUB_TOKEN }}
23+
publish_dir: ./public

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
public/

index.bs

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<pre class='metadata'>
2+
Title: RDF/JS: SHACL-UI specification
3+
Shortname: shacl-ui
4+
Level: 1
5+
Status: w3c/CG-DRAFT
6+
Group: RDF JavaScript Libraries Community Group
7+
Repository: rdfjs/shacl-ui
8+
URL: https://github.io/rdfjs/shacl-ui/
9+
Editor: Thomas Bergwinkl, https://www.bergnet.org/
10+
Abstract:
11+
This specification introduces an ontology that extends SHACL to define shape-driven UI components and layouts.
12+
Complain About: accidental-2119 yes, missing-example-ids yes
13+
Markup Shorthands: markdown yes, css no
14+
</pre>
15+
16+
# Introduction # {#intro}
17+
18+
*This section is non-normative*
19+
20+
The objective is to enhance the SHACL ontology to cater specifically to the UI use cases for application development and data exploration.
21+
It covers viewing, editing and filtering RDF data.
22+
Interfaces for reusable UI components should be established.
23+
To achieve this, we aim for implementations to rely on the SHACL ontology and the UI extension, enabling them to select UI components and generate layouts.
24+
The foundation for this will be the existing DASH ontology.
25+
The defined interfaces will enable seamless communication between implementations and UI components, enabling efficient viewing, editing or filtering of RDF data.
26+
Whenever feasible, we will utilize other RDF/JS specifications.

0 commit comments

Comments
 (0)