-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Apply the new design to the guidebook (#267)
@lcarcone @vivienlacourba, I'm starting this PR to redesign the guidebook. I've redesigned 2 pages for the example: 1. the documentreview with a HTML to markdown conversion. That method will take a while unless we can find a good tool to convert the markdown but it can be tricky as some parts of the page may still require HTML (you will see I left some tags, e.g. details/summary, dl/dt/dd) 2. the standards-track index page where I kept most of the initial HTML Happy to schedule a call to discuss the details with you --------- Co-authored-by: Vivien Lacourba <[email protected]> Co-authored-by: Laurent Carcone <[email protected]> Co-authored-by: Laurent Carcone <[email protected]> Co-authored-by: Ted Thibodeau Jr <[email protected]> Co-authored-by: Philippe Le Hegaret <[email protected]>
- Loading branch information
1 parent
e198737
commit e87e2bf
Showing
103 changed files
with
5,269 additions
and
10,503 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: Deploy Jekyll with GitHub Pages dependencies preinstalled | ||
|
||
on: | ||
# Runs on pushes targeting the default branch | ||
push: | ||
branches: ["main"] | ||
|
||
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
# Build job | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@086ffb1a2090c870a3f881cc91ea83aa4243d408 # v1.195.0 | ||
with: | ||
ruby-version: '3.2.3' # Not needed with a .ruby-version file | ||
bundler-cache: true # runs 'bundle install' and caches installed gems automatically | ||
- name: Build with Jekyll | ||
# Outputs to the './_site' directory by default | ||
run: bundle exec jekyll build | ||
env: | ||
JEKYLL_ENV: production | ||
- name: Upload artifact | ||
id: github-pages | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
name: github-pages | ||
path: _site/ | ||
|
||
# Deployment job | ||
deploy: | ||
needs: build | ||
permissions: | ||
pages: write | ||
id-token: write | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Gemfile.lock | ||
.jekyll-cache | ||
.jekyll-metadata | ||
_site |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
source "https://rubygems.org" | ||
# Hello! This is where you manage which Jekyll version is used to run. | ||
# When you want to use a different version, change it below, save the | ||
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: | ||
# | ||
# bundle exec jekyll serve | ||
# | ||
# This will help ensure the proper Jekyll version is running. | ||
# Happy Jekylling! | ||
gem "jekyll", "~> 4.1.0" | ||
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and | ||
# uncomment the line below. To upgrade, run `bundle update github-pages`. | ||
#gem "github-pages", group: :jekyll_plugins | ||
|
||
# our markdown files don't have frontmatter | ||
group :jekyll_plugins do | ||
gem "jekyll-relative-links" | ||
gem 'jekyll-commonmark' | ||
gem 'jekyll-remote-theme' | ||
gem 'jekyll-toc' | ||
gem 'webrick' | ||
end | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
title: W3C Guidebook | ||
baseurl: /guide | ||
remote_theme: w3c/w3c-jekyll-theme | ||
defaults: | ||
- | ||
scope: | ||
path: "" # an empty string here means all files in the project | ||
values: | ||
layout: "default" | ||
exclude: ["README.md", "**/README.md"] | ||
toc: | ||
max_level: 3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
pages: | ||
|
||
- title: W3C Guidebook | ||
url: /guide/ | ||
html: / | ||
|
||
- title: Buddy System | ||
url: /guide/chair/buddy.html | ||
html: /chair/buddy.html | ||
|
||
- title: Document Review | ||
url: /guide/documentreview/ | ||
html: /documentreview/ | ||
|
||
- title: Manual of style | ||
url: /guide/manual-of-style/ | ||
html: /manual-of-style/ | ||
|
||
- title: Meetings | ||
url: /guide/meetings/ | ||
html: /meetings/ | ||
|
||
- title: Standards track | ||
url: /guide/standards-track/ | ||
html: /standards-track/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
title: Publication Policies | ||
|
||
pages: | ||
|
||
- title: Technical Report Publication Policy | ||
url: https://www.w3.org/pubrules/ | ||
|
||
- title: About pubrules | ||
url: https://www.w3.org/pubrules/doc | ||
|
||
- title: Version Management in W3C Technical Reports | ||
url: https://www.w3.org/2005/05/tr-versions | ||
|
||
- title: Guidelines for linking to disclosure pages | ||
url: https://www.w3.org/2005/07/13-pubrules-disclosure | ||
|
||
- title: URIs for W3C Namespaces | ||
url: https://www.w3.org/2005/07/13-nsuri | ||
|
||
- title: How to Register a Media Type for a W3C Specification | ||
url: https://www.w3.org/2020/01/registering-mediatypes | ||
|
||
- title: XPointer Scheme Name Registry Policy | ||
url: https://www.w3.org/2005/04/xpointer-policy | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
path: | ||
- title: Home | ||
url: / |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<div class="component component--text"> | ||
<p><em>This <a href="https://github.com/w3c/guide/">document lives in GitHub</a>, where changes can be tracked and pull requests are welcome. Feedback and comments are welcome. Please use <a href="https://github.com/w3c/guide/issues">GitHub issues</a>.</em></p> | ||
</div> |
Oops, something went wrong.