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

Apply the new design to the guidebook #267

Draft
wants to merge 129 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
129 commits
Select commit Hold shift + click to select a range
981450a
use W3C jekyll template
deniak Nov 20, 2024
cb598a4
redesign documentreview
deniak Nov 20, 2024
00ac2a6
add standards-track to the navigation
deniak Nov 20, 2024
7ef7b1e
redesign standards-track
deniak Nov 20, 2024
5f14709
remove Gemfile.lock
deniak Nov 29, 2024
be2cf49
+ gitignore
deniak Nov 29, 2024
fd1b1c0
Remove unneeded assets
vivienlacourba Nov 29, 2024
ff13079
Rename createGitHubIssue.js in create-github-issue.js
vivienlacourba Nov 29, 2024
020da76
unneeded (/Guide/Jigedit/ doc is still hosted in CVS)
vivienlacourba Nov 29, 2024
612959c
convert to markdown
lcarcone Dec 3, 2024
7c4c947
add prefooter
deniak Dec 3, 2024
d93bc5a
rename
lcarcone Dec 3, 2024
eafa52b
fix link
lcarcone Dec 3, 2024
3a22f59
Revert "rename"
lcarcone Dec 3, 2024
a330cf4
renamed html into md
lcarcone Dec 3, 2024
394b629
renamed html into md
lcarcone Dec 3, 2024
a0a620a
Convert to markdown
lcarcone Dec 3, 2024
09de9c8
rename .html to .md
lcarcone Dec 4, 2024
2036501
convert to md
lcarcone Dec 4, 2024
699a64f
Rename from .html to .md
lcarcone Dec 4, 2024
1e1a95e
Convert to markdown
lcarcone Dec 4, 2024
55e0b10
Rename from .html to .md
lcarcone Dec 4, 2024
bc3f4b7
Convert to markdown
lcarcone Dec 4, 2024
0a5c59b
Rename from .html to .md
lcarcone Dec 4, 2024
4a95c9b
Convert to markdown
lcarcone Dec 4, 2024
e4bd50f
Rename from .html to .md
lcarcone Dec 9, 2024
dfc2622
Convert to markdown
lcarcone Dec 9, 2024
de7a8e5
Rename from .html to .md
lcarcone Dec 9, 2024
fdde2c5
Convert to markdown
lcarcone Dec 9, 2024
d53025a
Rename from .html to .md
lcarcone Dec 9, 2024
a70af8b
Convert to markdown
lcarcone Dec 9, 2024
6a7489c
use commonmark to benefit from description lists
deniak Dec 10, 2024
1cfb268
Apply suggestions from code review
lcarcone Dec 10, 2024
aca07f0
Update chair/role.md
vivienlacourba Dec 10, 2024
4e133b9
Update Markdown for definitions list
vivienlacourba Dec 10, 2024
3e84de2
Update Markdown for definitions list
lcarcone Dec 10, 2024
09eb016
Update Markdown for definitions list
vivienlacourba Dec 10, 2024
3d7a747
Use the quote component
vivienlacourba Dec 10, 2024
cc75922
Update Markdown for definitions list
vivienlacourba Dec 10, 2024
23d0615
Fix headings levels
vivienlacourba Dec 10, 2024
86b51e3
Update Markdown for definitions list in teh FAQ section
vivienlacourba Dec 10, 2024
dc55f0e
Use Markdown for definitions list in the Terminology and abbreviation…
vivienlacourba Dec 10, 2024
14922aa
Let markdown processor handle ordered list numbers
vivienlacourba Dec 10, 2024
1e9ded2
More Markdown usage and fixes
vivienlacourba Dec 10, 2024
d7ee115
Replace the 'githublabel' class by the 'tag' class from the W3C Desig…
vivienlacourba Dec 10, 2024
bc0b5b5
More Markdown usage and fixes
vivienlacourba Dec 10, 2024
28ad5c1
Move style block at the end of the document so that it does not mess …
vivienlacourba Dec 10, 2024
e054bf3
Use form markup from the W3C Design System
vivienlacourba Dec 10, 2024
e2ca050
Fix anchor
vivienlacourba Dec 10, 2024
1d397c6
Rename from .html to .md
lcarcone Dec 11, 2024
a57fa77
Convert to markdown
lcarcone Dec 11, 2024
a688375
Rename from .html to .md
lcarcone Dec 11, 2024
874ca7c
Convert to markdown
lcarcone Dec 11, 2024
09eabbd
Rename from .html to .md
lcarcone Dec 11, 2024
e4c7dee
Convert to markdown
lcarcone Dec 11, 2024
ddfd215
Rename from .html to .md
lcarcone Dec 11, 2024
1c9a13b
Convert to markdown
lcarcone Dec 11, 2024
1cb0e54
Rename from .html to .md
lcarcone Dec 11, 2024
68b3881
Convert to markdown
lcarcone Dec 11, 2024
a12d19e
Rename from .html to .md
lcarcone Dec 13, 2024
ce55967
Convert to markdown
lcarcone Dec 13, 2024
d6ed94f
Rename from .html to .md
lcarcone Dec 13, 2024
4738822
Convert to markdown preserving ids
lcarcone Dec 13, 2024
5ebe94b
Rename from .html to .md
lcarcone Dec 13, 2024
22d55a2
Convert to markdown
lcarcone Dec 13, 2024
9fe7787
Rename from .html to .md
lcarcone Dec 13, 2024
6f9586c
Convert to markdown
lcarcone Dec 13, 2024
936503b
Rename from .html to .md
lcarcone Dec 13, 2024
5660e25
Convert to markdown
lcarcone Dec 13, 2024
ee17b84
Rename from .html to .md
lcarcone Dec 13, 2024
65a3b3f
Convert to markdown
lcarcone Dec 13, 2024
38c7cc6
Rename from .html to .md
lcarcone Dec 13, 2024
cf56c6d
Convert to markdown preserving headers id
lcarcone Dec 13, 2024
b915d8c
Rename from .html to .md
lcarcone Dec 13, 2024
848db3b
Started conversion to markdown
lcarcone Dec 13, 2024
0974eb4
Convert to markdown
lcarcone Dec 16, 2024
e0fb4cd
Rename from .html to .md
lcarcone Dec 16, 2024
8c0c86f
Convert to markdown
lcarcone Dec 16, 2024
20acf4d
Rename from .html to .md
lcarcone Dec 16, 2024
6f0468d
Convert to markdown
lcarcone Dec 16, 2024
6bec9c5
Convert to markdown
lcarcone Dec 16, 2024
085f9d2
Rename from .html to .md
lcarcone Dec 16, 2024
3a45119
Convert to markdown
lcarcone Dec 16, 2024
ed4b62b
Rename from .html to .md
lcarcone Dec 16, 2024
534b3e9
Convert to markdown
lcarcone Dec 16, 2024
9e803e6
Rename from .html to .md
lcarcone Dec 16, 2024
4575ce4
Convert to markdown
lcarcone Dec 16, 2024
f83505b
Rename from .html to .md
lcarcone Dec 16, 2024
872cbb3
Convert to markdown
lcarcone Dec 16, 2024
322d7cd
Rename from .html to .md
lcarcone Dec 16, 2024
c048c33
Convert to markdown
lcarcone Dec 16, 2024
1410a1d
Rename from .html to .md
lcarcone Dec 16, 2024
1c93e7b
Convert to markdown
lcarcone Dec 16, 2024
56695d4
adapt existing markdown file to jekyll template
lcarcone Dec 17, 2024
e650dc7
adapt existing markdown file to jekyll template
lcarcone Dec 17, 2024
c7346eb
adapt existing markdown file to jekyll template
lcarcone Dec 17, 2024
e348ad8
add missing ids for headers
lcarcone Dec 17, 2024
9359209
add missing ids for headers
lcarcone Dec 17, 2024
9f23333
add missing ids for headers
lcarcone Dec 17, 2024
6a7a7d2
add missing ids for headers
lcarcone Dec 17, 2024
6b39413
add missing ids for headers
lcarcone Dec 17, 2024
42eb120
add ids and quote
lcarcone Dec 17, 2024
da9e659
adapt the markdown syntax + use '\' to escape the numbers
lcarcone Dec 18, 2024
b5db4c9
remove <h2> and first sentence as a duplicate of <h1>, remove toc
lcarcone Dec 18, 2024
6a5ecee
Rename horizontal-groups from .html to .md
lcarcone Dec 18, 2024
5504f40
Convert horizontal-groups to markdown
lcarcone Dec 18, 2024
170fbd9
replace the quote component for examples
lcarcone Dec 18, 2024
cf98647
use a <ul> without a prefixed letter for each item
lcarcone Dec 18, 2024
64dd115
Rename normative-references from .html to .md
lcarcone Dec 18, 2024
bd9208f
Convert normative-references to markdown
lcarcone Dec 18, 2024
38c6934
add toc
lcarcone Dec 18, 2024
5f86371
Rename tools/new-group from .html to .md
lcarcone Dec 18, 2024
b1a3911
Convert tools/new-group to markdown
lcarcone Dec 18, 2024
5302253
Complete the conversion of tools/new-group to markdown
lcarcone Dec 18, 2024
7d1aacb
add ids and quote component
lcarcone Dec 18, 2024
3a966ee
Rename editors-draft from .html to .md
lcarcone Dec 18, 2024
f9a1250
Convert editors-draft to markdown
lcarcone Dec 18, 2024
4af150b
typo
lcarcone Dec 18, 2024
5f6abdf
adapt resources.md to the jekyll template, keep only one <h1> and cha…
lcarcone Dec 18, 2024
d5d6a07
Rename editor/index from .html to .md
lcarcone Dec 18, 2024
fc0b408
Convert editor/index to markdown
lcarcone Dec 18, 2024
66c9ccd
Rename HOWTO.md
lcarcone Dec 18, 2024
517c896
adapt howto.md to the jekyll template
lcarcone Dec 18, 2024
9288e2f
Rename process/predicting-milestones from .html to .md
lcarcone Dec 20, 2024
b598f9c
Convert process/predicting-milestones to markdown (in progress)
lcarcone Dec 20, 2024
01227bd
Rename incubation from .html to .md
lcarcone Dec 20, 2024
14552c9
Convert incubation to markdown
lcarcone Dec 20, 2024
5b8c426
Add classes and style to differentiate "Time" and "Tips"
lcarcone Dec 20, 2024
b154ac2
typo
lcarcone Dec 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
26 changes: 26 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
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-optional-front-matter'
gem "jekyll-readme-index"
gem "jekyll-titles-from-headings"
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.

19 changes: 19 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
title: W3C Guidebook
baseurl: /guide
remote_theme: w3c/w3c-jekyll-theme
titles_from_headings:
enabled: true
strip_title: true
collections: false
defaults:
-
scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"
optional_front_matter:
remove_originals: true
readme_index:
remove_originals: true
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/
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: /
1 change: 1 addition & 0 deletions _includes/prefooter.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<p>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>.</p>
85 changes: 0 additions & 85 deletions chair/buddy.html

This file was deleted.

53 changes: 53 additions & 0 deletions chair/buddy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: W3C Chair Buddy System
toc: true
---

The [Working Group effectiveness Task Force](https://github.com/w3c/wg-effectiveness) helped establish a Chair Buddy System by which experienced Chairs can volunteer as buddy-mentors to help buddy-mentees Chairs.

Interested parties should subscribe to [[email protected]](mailto:[email protected]) ([Member-only archive](https://lists.w3.org/Archives/Member/member-chairbuddies/)[). Chairs have access to their contact information via the]() [Chairs group](https://www.w3.org/2000/09/dbwg/details?group=31972).

## Principles

- This program is under the responsibility of the [W3C Project Lead](https://www.w3.org/staff/project/).
- W3C Chairs self-declare as Mentors or Mentees by writing to [[email protected]](mailto:[email protected]).

- Ideally, they add their names to this page by [editing it on GitHub](https://github.com/w3c/Guide/edit/main/chair/buddy.md).
- The W3C Project Lead proceeds to pairing those who request to have a buddy, with those who volunteer to be a buddy.

## Buddy-Mentors

Thank-you for agreeing to be a W3C Chair Buddy! You should have been assigned your buddy-mentee and received their details from the W3C Team. If not, please ask the W3C Project Lead. Here are some resources and guidelines for helping you get started with being a buddy-mentor.

- Email your buddy-mentee and introduce yourself! It helps if you give some details on your chair experience, some general W3C experience, and what groups you have interests in.
- Arrange an initial meeting with your buddy-mentee. This can be a teleconference, or face-to-face if you're lucky to live in the same area or are participating in the same meeting.
- Buddy meetings can be managed however you wish, some guidelines are given below:

- Ask questions such as "how long have you been chairing?", "what is the size of your group?", "how many chairs are there?", "what are you group working practices?", "how do you manage and conduct meetings?", "how many documents and editors do you have?", "what are your document timelines?", "tell me about your editors / participants", "where are your participants based?".
- Finding out as much as you can about your buddy-mentee will allow you to give the best advice!
- Try to speak to your buddy-mentee every quarter. The job of arranging meetings should be with the buddy-mentee, but it doesn't hurt to send them a quick email every so often!

Self-declared Buddy-Mentors:

- [Anssi Kostiainen](https://github.com/anssiko)
- [Léonie Watson](https://github.com/ljwatson)
- [Charles Nevile](https://github.com/chaals)
- [Nigel Megitt](https://github.com/nigelmegitt)

## Buddy-Mentees

Thank-you for joining the W3C Chair Buddy system! As a buddy-mentee you should have received details of your buddy. If you have not please ask the W3C Project Lead. Here are some guidelines for being a buddy-mentee.

- Email your buddy-mentor and introduce yourself! Give details on the group you chair, whether you have a co-chair, and some quick details on the specs you're working on and the size of your group.
- Arrange an initial meeting with your buddy-mentor. This can be a teleconference, or face-to-face if you're lucky to live in the same area or are participating in the same meeting.
- Buddy meetings can be managed however you wish, some guidelines are given below:

- You should be giving your buddy-mentor as much information as possible about your current chairing situation, this will help them give you the best advice!
- You should also bring with you a list of your own questions, here are some examples: "how do you manage consensus when one or few people are blocking?", "how do you manage meetings when participants are so distributed?", "how can I help my editors get to work?", etc.
- Try to speak to your buddy-mentor every quarter, but you may speak to them more infrequently or frequently depending on what works for you and your buddy-mentor. In yuor initial meeting try to discuss a schedule for meetings (even if you decide to do ad-hoc meetings) then arrange the meetings by sending calendar invites (or another method of your choosing).
- It's up to you to arrange these meetings (buddy-mentors may have a few mentees, so it's best for buddy-mentees to arrange meetings).

Self-declared Buddy-Mentees:

- Karen Coyle (now associated with Léonie Watson)
- Wendy Reid
Loading