From 177e7d64aa8bb432bcdbeb9a9f4c8ea433f8c104 Mon Sep 17 00:00:00 2001 From: Hadrian Zbarcea Date: Sat, 14 Dec 2024 14:49:42 -0500 Subject: [PATCH 1/2] Add #github option to autogen edDraftURI Signed-off-by: Hadrian Zbarcea --- spec/index.html | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/index.html b/spec/index.html index 9513400..35fe951 100644 --- a/spec/index.html +++ b/spec/index.html @@ -10,6 +10,7 @@ specStatus: "ED", shortName: "lws-ucs", copyrightStart: "2024", + github: "w3c/lws-ucs", // previousPublishDate: "N/A", editors: [ { name: "Pierre-Antoine Champin" }, From 64e335613515adc306d14ac0b4114b4a4927ac20 Mon Sep 17 00:00:00 2001 From: Hadrian Zbarcea Date: Sat, 14 Dec 2024 15:12:12 -0500 Subject: [PATCH 2/2] Move building instructions out of README Signed-off-by: Hadrian Zbarcea --- BUILDING.md | 30 ++++++++++++++++++++++++++++++ README.md | 33 --------------------------------- 2 files changed, 30 insertions(+), 33 deletions(-) create mode 100644 BUILDING.md diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..cd2a78b --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,30 @@ +# How to build this spec + +This repository uses the [ReSpec toolchain](https://respec.org/docs/). Please find below a quick getting started cheatsheet using the [command line](https://respec.org/docs/#using-command-line) tools. + +Setup `respec` for multiple use: +``` +$ npm install --global respec +``` +Update your environment with the following variables: +``` +export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1 +export PUPPETEER_EXECUTABLE_PATH="/usr/bin/google-chrome" +# replace "/usr/bin/google-chrome" with path to Chrome executable on your system. +# On MacOS, it's generally: +# "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" +``` +This spec uses the `data-include` attribute. For `respec` to work locally, the content MUST be served by a web server. One easy way to achive that is to run one from the project directory: +``` +# Install a local HTTP server if not already installed (one time) +$ npm install -g http-server + +# Start the server in your project directory +$ http-server +``` + +Note that the server starts on port 8080. Now you can run `respec` to generate the spec [`index.html`](http://localhost:8080/index.html) in the project root and test changes. +``` +$ respec --src http://localhost:8080/spec/index.html --out index.html +``` + diff --git a/README.md b/README.md index 645ad58..c1ce511 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # Specification 'lws-ucs' This is the repository for lws-ucs. You're welcome to contribute! Let's make the Web rock our socks @@ -13,35 +12,3 @@ LWS user stories are classified under the following categories: * Technical: related to infrastructure tasks (e.g., "As a Service Provider, I want the ability to archive LWS storages"). * Spike: used to explore or research an unknown aspect of the project (e.g., "Research what Identity System supports delegation."). -## How to build this spec - -This repository uses the [ReSpec toolchain](https://respec.org/docs/). Please find below a quick getting started cheatsheet using the [command line](https://respec.org/docs/#using-command-line) tools. - -Setup `respec` for multiple use: -``` -$ npm install --global respec -``` -Update your environment with the following variables: -``` -export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=1 -export PUPPETEER_EXECUTABLE_PATH="/usr/bin/google-chrome" -# replace "/usr/bin/google-chrome" with path to Chrome executable on your system. -# On MacOS, it's generally: -# "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome" -``` -This spec uses the `data-include` attribute. For `respec` to work locally, the content MUST be served by a web server. One easy way to achive that is to run one from the project directory: -``` -# Install a local HTTP server if not already installed (one time) -$ npm install -g http-server - -# Start the server in your project directory -$ http-server -Starting up http-server, serving ./ - -http-server version: 14.1.1 -``` - -Note that the server starts on port 8080. Now you can run `respec` to generate the spec [`index.html`](http://localhost:8080/index.html) in the project root and test changes. -``` -$ respec --src http://localhost:8080/spec/index.html --out index.html -```