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

Migration to W3C API #369

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Gemfile.lock
Expand Up @@ -60,6 +60,7 @@ GEM
webrick (1.7.0)

PLATFORMS
arm64-darwin-21
universal-darwin-22
x64-unknown
x86_64-linux
Expand Down
55 changes: 35 additions & 20 deletions docs/README.md
Expand Up @@ -3,9 +3,10 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/d51b6c04-7def-43c0-8566-4f16ed11c213/deploy-status)](https://app.netlify.com/sites/wot-marketing/deploys)

The content will be exposed to
* https://www.w3.org/WoT/ (official page)
* https://w3c.github.io/wot-marketing/ (GitHub pages render)
* https://wot-marketing.netlify.app/ (Netlify is used for PR previews and build badge)

* <https://www.w3.org/WoT/> (official page)
* <https://w3c.github.io/wot-marketing/> (GitHub pages render)
* <https://wot-marketing.netlify.app/> (Netlify is used for PR previews and build badge)

## Contribution Rules

Expand All @@ -28,39 +29,53 @@ If you are using MacOS, please refer to the [official MacOS installation guide](

### Installing the Dependencies

- Run `bundle install` . This will install all the dependencies via bundler using the Gemfile
* Run `bundle install` . This will install all the dependencies via bundler using the Gemfile

### Generating the Webpage

- During development, you can use one of the following to dynamically render the page with each change and make it available at `localhost`:
- `bundle exec jekyll serve` to use the default config
- `bundle exec jekyll serve --config _config.yml,_config_dev.yml` to use another config
* During development, you can use one of the following to dynamically render the page with each change and make it available at `localhost`:
* `bundle exec jekyll serve` to use the default config
* `bundle exec jekyll serve --config _config.yml,_config_dev.yml` to use another config

- For deployment where you want to have the static HTML sources, you can use
- `bundle exec jekyll build` which will make the sources available at `_site` folder
* For deployment where you want to have the static HTML sources, you can use
* `bundle exec jekyll build` which will make the sources available at `_site` folder

### Adding dependencies

When you want to add dependencies, like [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap), you should do this by one of the following ways:
- Add the dependency to the Gemfile and run `bundle update` which will install the dependency
- Run `bundle add jekyll-sitemap` which will install the dependency and modify the Gemfile automatically

* Add the dependency to the Gemfile and run `bundle update` which will install the dependency
* Run `bundle add jekyll-sitemap` which will install the dependency and modify the Gemfile automatically

## Netlify Configuration

We are using [Netlify](https://www.netlify.com/) to build previews for PRs.
We are using an open source account from Netlify with all TF members having access to it.
If the TF is not responding to possible failures in the pipeline, another person has to do everything. This means the following:

- Create a page/project at Netlify
- Link it to this GitHub repository
- Choose the following build settings
- `docs` folder as base directory
- `bundle install && bundle exec jekyll build` as build command
- publish directory `docs/_site`
- For enabling PR Reviews, you also need to give the Netlify bot access to your account. Authorization from W3C is not needed.
* Create a page/project at Netlify
* Link it to this GitHub repository
* Choose the following build settings
* `docs` folder as base directory
* `bundle install && bundle exec jekyll build` as build command
* publish directory `docs/_site`
* For enabling PR Reviews, you also need to give the Netlify bot access to your account. Authorization from W3C is not needed.


See also: https://github.com/w3c/wot-marketing/issues/148#issuecomment-1058299754
See also: <https://github.com/w3c/wot-marketing/issues/148#issuecomment-1058299754>

## Adapting to Daylight Saving Changes

When a zone changes its time relative to UTC, you need to a bunch of changes. See [this PR](https://github.com/w3c/wot-marketing/pull/296) for concrete information

## W3C API Related Information

Here are some links and important information:

* WoT WG id: 95969
* WoT IG id: 75874
* WoT CG id: 63991
* WoT Japanese CG: 129080
* WebThing Protocol CG: 117875
* API Documentation: <https://api.w3.org/doc>
* API Overview: <https://www.w3.org/api/>
* Library we are using: <https://github.com/w3c/apiary>
7 changes: 7 additions & 0 deletions docs/_config.yml
Expand Up @@ -9,6 +9,13 @@ baseurl: "/WoT"
github_username: "w3c"
git_repo: "wot-marketing"

apidata:
wgchair: "Michael McCool"
wg:
chairs:
name: "Michael McCool"
company: Intel

navigation:
- title: Groups
subnavigation:
Expand Down
3 changes: 3 additions & 0 deletions docs/_layouts/default.html
Expand Up @@ -239,9 +239,12 @@ <h2 style="font-size:22px; color:#005A9C; font-weight: bold;">Web of Things</h2>
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script src="{{'/js/bootstrap.min.js' | absolute_url }}"></script>
<!-- W3C API library -->
<script src="//w3c.github.io/apiary/apiary.js"></script>
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
<!-- <script src="../../assets/js/ie10-viewport-bug-workaround.js"></script> -->

</div><!-- outer container -->
</body>
</html>
<html data-apiary-key="mcfz5sscupwkc04s84ocsco0swgk04c"></html>
8 changes: 6 additions & 2 deletions docs/wg/index.html
Expand Up @@ -3,12 +3,16 @@
title: W3C WoT – Working Group
group: "navigation"
---
<div>
<div data-apiary-group="95969">
<h2>W3C WoT – Working Group</h2>
<!-- <span class="apiary-done" data-apiary="chairs">[Loading...]</span>
<span class="apiary-done" data-apiary="users">[Loading...]</span> -->

<p>
The W3C WoT Working Group (WG) is tasked to create standards-track specifications and test suites. To ensure royalty-free Web standards, participants must be W3C and WoT WG Members and acknowledge the <a href="https://www.w3.org/Consortium/Patent-Policy-20040205/">W3C Patent Policy</a>.
</p>
<p>Co-Chairs: <a href="mailto:michael.mccool@intel.com">Michael McCool (Intel)</a> and <a href="mailto:sebastian.kaebisch@siemens.com">Sebastian K&auml;bisch (Siemens AG)</a></p>
<p>Co-Chairs:
<a href="mailto:michael.mccool@intel.com">{{site.apidata.wgchair}} (Intel)</a> and <a href="mailto:sebastian.kaebisch@siemens.com">Sebastian K&auml;bisch (Siemens AG)</a></p>
<p>Team contacts: <a href="https://www.w3.org/People#ashimura" target="_blank">Kazuyuki Ashimura</a> and <a href="https://www.w3.org/People#dsr" target="_blank">Dave Raggett</a></p>

<p>&nbsp;</p>
Expand Down