Skip to content

Commit

Permalink
Apply the new design to the guidebook (#267)
Browse files Browse the repository at this point in the history
@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
6 people authored Jan 15, 2025
1 parent e198737 commit e87e2bf
Show file tree
Hide file tree
Showing 103 changed files with 5,269 additions and 10,503 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/jekyll-gh-pages.yml
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Gemfile.lock
.jekyll-cache
.jekyll-metadata
_site
23 changes: 23 additions & 0 deletions Gemfile
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

7 changes: 0 additions & 7 deletions Jigedit/.htaccess

This file was deleted.

30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Guide

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

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
together.
Expand All @@ -17,37 +17,37 @@ The general edition of the Guidebook is managed by [@w3c/guidebook](https://gith

## In this repository

* [/chair/](https://github.com/w3c/Guide/tree/main/chair)
* [/chair/](tree/main/chair)
* Instructions on how to chair WGs and IGs including managing meetings, setting up the homepage, maintaining the calendar.
* [/council/](https://github.com/w3c/Guide/tree/main/council)
* [/council/](tree/main/council)
* Anything related to councils.
* [/documentreview/](https://github.com/w3c/Guide/tree/main/documentreview)
* [/documentreview/](tree/main/documentreview)
* How to do wide review.
* [/editor/](https://github.com/w3c/Guide/tree/main/editor)
* [/editor/](tree/main/editor)
* How to author a specification, including ReSpec or other spec making programs.
* [/manual-of-style/](https://github.com/w3c/Guide/tree/main/manual-of-style)
* [/manual-of-style/](tree/main/manual-of-style)
* The W3C Manual of Style for editors.
* [/meetings/](https://github.com/w3c/Guide/tree/main/meetings)
* [/meetings/](tree/main/meetings)
* Anything related to organizing meetings, including events.
* [/process/](https://github.com/w3c/Guide/tree/main/process)
* [/process/](tree/main/process)
* Anything related to additional guidelines when following the process.
* You may involve [@w3c/w3process-editors](https://github.com/orgs/w3c/teams/w3process-editors).
* [/process/tilt/](https://github.com/w3c/Guide/tree/main/process/tilt)
* [/process/tilt/](tree/main/process/tilt)
* Anything related to technical Team decision and verification, except for transitions.
* Managed by [@w3c/tilt](https://github.com/orgs/w3c/teams/tilt)
* [/standards-track/](https://github.com/w3c/Guide/tree/main/standards-track).
* [/standards-track/](tree/main/standards-track).
* Best Practices for Bringing Work to the W3C Recommendation Track.
* [/teamcontact/](https://github.com/w3c/Guide/tree/main/teamcontact)
* [/teamcontact/](tree/main/teamcontact)
* Guidance on the role of the team contact, and what to expect from them.
* [/transitions/](https://github.com/w3c/Guide/tree/main/transitions)
* [/transitions/](tree/main/transitions)
* Organize a Technical Report Transition.
* Managed by [@w3c/transitions](https://github.com/orgs/w3c/teams/transitions).
* [/other/](https://github.com/w3c/Guide/tree/main/other)
* [/other/](tree/main/other)
* Related to [permanent groups](https://www.w3.org/groups/).

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

Note: now that we have a repository for the guidebook, simply add your documentation into it rather than creating new repositories.
Note: now that we have a repository for the guidebook, simply add your documentation to it, rather than creating new repositories.
12 changes: 12 additions & 0 deletions _config.yml
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
25 changes: 25 additions & 0 deletions _data/navigation.yml
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/
25 changes: 25 additions & 0 deletions _data/submenu-publication-policies.yml
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

3 changes: 3 additions & 0 deletions _data/subpath.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
path:
- title: Home
url: /
3 changes: 3 additions & 0 deletions _includes/prefooter.html
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>
Loading

0 comments on commit e87e2bf

Please sign in to comment.