Skip to content

Commit e87e2bf

Browse files
deniakvivienlacourbalcarconeTallTedplehegar
authored
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]>
1 parent e198737 commit e87e2bf

File tree

103 files changed

+5269
-10503
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+5269
-10503
lines changed

‎.github/workflows/jekyll-gh-pages.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
8+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
9+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
10+
concurrency:
11+
group: "pages"
12+
cancel-in-progress: false
13+
14+
jobs:
15+
# Build job
16+
build:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v4
21+
- name: Setup Ruby
22+
uses: ruby/setup-ruby@086ffb1a2090c870a3f881cc91ea83aa4243d408 # v1.195.0
23+
with:
24+
ruby-version: '3.2.3' # Not needed with a .ruby-version file
25+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
26+
- name: Build with Jekyll
27+
# Outputs to the './_site' directory by default
28+
run: bundle exec jekyll build
29+
env:
30+
JEKYLL_ENV: production
31+
- name: Upload artifact
32+
id: github-pages
33+
uses: actions/upload-pages-artifact@v3
34+
with:
35+
name: github-pages
36+
path: _site/
37+
38+
# Deployment job
39+
deploy:
40+
needs: build
41+
permissions:
42+
pages: write
43+
id-token: write
44+
environment:
45+
name: github-pages
46+
url: ${{ steps.deployment.outputs.page_url }}
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Gemfile.lock
2+
.jekyll-cache
3+
.jekyll-metadata
4+
_site

‎Gemfile

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
source "https://rubygems.org"
2+
# Hello! This is where you manage which Jekyll version is used to run.
3+
# When you want to use a different version, change it below, save the
4+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
5+
#
6+
# bundle exec jekyll serve
7+
#
8+
# This will help ensure the proper Jekyll version is running.
9+
# Happy Jekylling!
10+
gem "jekyll", "~> 4.1.0"
11+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
12+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
13+
#gem "github-pages", group: :jekyll_plugins
14+
15+
# our markdown files don't have frontmatter
16+
group :jekyll_plugins do
17+
gem "jekyll-relative-links"
18+
gem 'jekyll-commonmark'
19+
gem 'jekyll-remote-theme'
20+
gem 'jekyll-toc'
21+
gem 'webrick'
22+
end
23+

‎Jigedit/.htaccess

-7
This file was deleted.

‎README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Guide
22

3-
The repository for "[The Art of Consensus](https://www.w3.org/Guide/)", W3C's Chair's Guidebook.
3+
The repository for "[The Art of Consensus](https://www.w3.org/guide/)", W3C's Chair's Guidebook.
44

55
Documentation on how to participate in W3C WGs is split between multiple wikipages, github repos and emails. This means new members find difficulty in finding information as to how to participate and maybe give up trying. This repository is the place to pull all of those
66
together.
@@ -17,37 +17,37 @@ The general edition of the Guidebook is managed by [@w3c/guidebook](https://gith
1717

1818
## In this repository
1919

20-
* [/chair/](https://github.com/w3c/Guide/tree/main/chair)
20+
* [/chair/](tree/main/chair)
2121
* Instructions on how to chair WGs and IGs including managing meetings, setting up the homepage, maintaining the calendar.
22-
* [/council/](https://github.com/w3c/Guide/tree/main/council)
22+
* [/council/](tree/main/council)
2323
* Anything related to councils.
24-
* [/documentreview/](https://github.com/w3c/Guide/tree/main/documentreview)
24+
* [/documentreview/](tree/main/documentreview)
2525
* How to do wide review.
26-
* [/editor/](https://github.com/w3c/Guide/tree/main/editor)
26+
* [/editor/](tree/main/editor)
2727
* How to author a specification, including ReSpec or other spec making programs.
28-
* [/manual-of-style/](https://github.com/w3c/Guide/tree/main/manual-of-style)
28+
* [/manual-of-style/](tree/main/manual-of-style)
2929
* The W3C Manual of Style for editors.
30-
* [/meetings/](https://github.com/w3c/Guide/tree/main/meetings)
30+
* [/meetings/](tree/main/meetings)
3131
* Anything related to organizing meetings, including events.
32-
* [/process/](https://github.com/w3c/Guide/tree/main/process)
32+
* [/process/](tree/main/process)
3333
* Anything related to additional guidelines when following the process.
3434
* You may involve [@w3c/w3process-editors](https://github.com/orgs/w3c/teams/w3process-editors).
35-
* [/process/tilt/](https://github.com/w3c/Guide/tree/main/process/tilt)
35+
* [/process/tilt/](tree/main/process/tilt)
3636
* Anything related to technical Team decision and verification, except for transitions.
3737
* Managed by [@w3c/tilt](https://github.com/orgs/w3c/teams/tilt)
38-
* [/standards-track/](https://github.com/w3c/Guide/tree/main/standards-track).
38+
* [/standards-track/](tree/main/standards-track).
3939
* Best Practices for Bringing Work to the W3C Recommendation Track.
40-
* [/teamcontact/](https://github.com/w3c/Guide/tree/main/teamcontact)
40+
* [/teamcontact/](tree/main/teamcontact)
4141
* Guidance on the role of the team contact, and what to expect from them.
42-
* [/transitions/](https://github.com/w3c/Guide/tree/main/transitions)
42+
* [/transitions/](tree/main/transitions)
4343
* Organize a Technical Report Transition.
4444
* Managed by [@w3c/transitions](https://github.com/orgs/w3c/teams/transitions).
45-
* [/other/](https://github.com/w3c/Guide/tree/main/other)
45+
* [/other/](tree/main/other)
4646
* Related to [permanent groups](https://www.w3.org/groups/).
4747

4848
# Related repositories
4949
* [//w3c.github.io](https://github.com/w3c/w3c.github.io)
5050
* How to use Git and GitHub at W3C.
51-
* This repository is not exposed through [the Guidebook](https://www.w3.org/Guide/).
51+
* This repository is not exposed through [the Guidebook](https://www.w3.org/guide/).
5252

53-
Note: now that we have a repository for the guidebook, simply add your documentation into it rather than creating new repositories.
53+
Note: now that we have a repository for the guidebook, simply add your documentation to it, rather than creating new repositories.

‎_config.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
title: W3C Guidebook
2+
baseurl: /guide
3+
remote_theme: w3c/w3c-jekyll-theme
4+
defaults:
5+
-
6+
scope:
7+
path: "" # an empty string here means all files in the project
8+
values:
9+
layout: "default"
10+
exclude: ["README.md", "**/README.md"]
11+
toc:
12+
max_level: 3

‎_data/navigation.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
pages:
2+
3+
- title: W3C Guidebook
4+
url: /guide/
5+
html: /
6+
7+
- title: Buddy System
8+
url: /guide/chair/buddy.html
9+
html: /chair/buddy.html
10+
11+
- title: Document Review
12+
url: /guide/documentreview/
13+
html: /documentreview/
14+
15+
- title: Manual of style
16+
url: /guide/manual-of-style/
17+
html: /manual-of-style/
18+
19+
- title: Meetings
20+
url: /guide/meetings/
21+
html: /meetings/
22+
23+
- title: Standards track
24+
url: /guide/standards-track/
25+
html: /standards-track/

‎_data/submenu-publication-policies.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
title: Publication Policies
2+
3+
pages:
4+
5+
- title: Technical Report Publication Policy
6+
url: https://www.w3.org/pubrules/
7+
8+
- title: About pubrules
9+
url: https://www.w3.org/pubrules/doc
10+
11+
- title: Version Management in W3C Technical Reports
12+
url: https://www.w3.org/2005/05/tr-versions
13+
14+
- title: Guidelines for linking to disclosure pages
15+
url: https://www.w3.org/2005/07/13-pubrules-disclosure
16+
17+
- title: URIs for W3C Namespaces
18+
url: https://www.w3.org/2005/07/13-nsuri
19+
20+
- title: How to Register a Media Type for a W3C Specification
21+
url: https://www.w3.org/2020/01/registering-mediatypes
22+
23+
- title: XPointer Scheme Name Registry Policy
24+
url: https://www.w3.org/2005/04/xpointer-policy
25+

‎_data/subpath.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
path:
2+
- title: Home
3+
url: /

‎_includes/prefooter.html

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div class="component component--text">
2+
<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>
3+
</div>

0 commit comments

Comments
 (0)