diff --git a/mock/chairs/advice.md b/mock/chairs/advice.md new file mode 100644 index 000000000..1f96d62d5 --- /dev/null +++ b/mock/chairs/advice.md @@ -0,0 +1,18 @@ +# Guidelines and Advice for Running a Group + +## Menu +* [Advice](#advice) +* [CSI](#csi) +* [Getting help from the Team](#getting-help-from-the-team) +* [<- Back to **Chairs**](index.md#) + +## Content +### Advice +@todo break this down. + +### Common Standards Issues +Link to [Common Standards Issues Document](https://github.com/w3c/wg-effectiveness/blob/master/CSI.md) + +### Getting help from the Team +plh? + diff --git a/mock/chairs/buddysystem.md b/mock/chairs/buddysystem.md new file mode 100644 index 000000000..43a9f1230 --- /dev/null +++ b/mock/chairs/buddysystem.md @@ -0,0 +1,8 @@ +# Chair Buddy System +## Menu +* [<- Back to **Chairs**](index.md#) + +## Content +Take and modify content from + +REDIRECT NEEDED: will redirect here. diff --git a/mock/chairs/index.md b/mock/chairs/index.md new file mode 100644 index 000000000..10b7c25dc --- /dev/null +++ b/mock/chairs/index.md @@ -0,0 +1,17 @@ +# Information For Chairs + +## Menu +* [Meetings](meetings.md) +* [Tools For Running a WG / IG](tools.md) +* [Guidelines and Advice for Running a Group](advice.md) +* [Starting a Group](starting_a_group.md) +* [Chair Buddy System](buddysystem.md) +* [Rec Track](#) (link to another section of /guide) +* [Milestones](milestones.md) +* [<- Back to **Home**](../index.md#) + +## Content +Here find all the information you need on being a chair of a W3C Working or Business Group. + +### Hot Links +Add Content diff --git a/mock/chairs/meetings.md b/mock/chairs/meetings.md new file mode 100644 index 000000000..7aa260556 --- /dev/null +++ b/mock/chairs/meetings.md @@ -0,0 +1,25 @@ +# Meetings +## Menu +* [Quick start guide](#) (below) +* [Setting Up Teleconfs](#) (below) +* [Face-to-Face Meetings](#) (below) +* [IRC / Scribing](#) (link to other section) +* [<- Back to **Chairs**](index.md#) + +## Content +Information on managing and running meetings. + +### Quick start guide for setting up tools for managing an agenda, generating minutes, and updating issues lists +Take and modify content from + +### Setting up Teleconferences +Take and modify content from + +### Host a face-to-face meeting +Take and modify content from , +, +, + +W3C have an "[Holidays Wiki](https://www.w3.org/wiki/Holidays)" which can help you miss important cultural holidays to allow for maximum participation at your face-to-face meeting. + + diff --git a/mock/chairs/milestones.md b/mock/chairs/milestones.md new file mode 100644 index 000000000..5846a726e --- /dev/null +++ b/mock/chairs/milestones.md @@ -0,0 +1,7 @@ +# Milestones +## Menu +@todo +* [<- Back to **Members and Participants**](index.md) + +## Content +How to create and manage milestones for your group deliverables. diff --git a/mock/chairs/starting_a_group.md b/mock/chairs/starting_a_group.md new file mode 100644 index 000000000..4ee1a6ab4 --- /dev/null +++ b/mock/chairs/starting_a_group.md @@ -0,0 +1,34 @@ +# Starting a Group +## Menu +* [Is starting a group the right course of action?]() (below) +* [Incubation and WICG](../editors/incubation.md) (link to Incubation in editors section) +* [Community Groups](#) (below) +* [Starting a Business Group](#) (below) +* [Starting a Working Group](#) (below) +* [Creating a Charter](#) (below) +* [Amending a Charter](#) (below) +* [<- Back to **Chairs**](index.md#) + +## Content +Find out whether starting a new group is the right course of action and how to start a group below! + +### Is starting a group the right course of action? +Add content. + +See [Incubation and WICG](../editors/incubation.md) also. + +### Community Groups +Add content. + +### Starting a Business Group +Text. Link to "Creating a Charter". + +### Starting a Working Group +Text. Link to "Creating a Charter". + +### Creating a Charter +Add content. + +### Amending a Charter +Add Content. + diff --git a/mock/chairs/tools.md b/mock/chairs/tools.md new file mode 100644 index 000000000..ed9f9e23d --- /dev/null +++ b/mock/chairs/tools.md @@ -0,0 +1,30 @@ +# Tools For Running a WG / IG +## Menu +* [Mailing List](#) (below) +* [W3C Wiki](#) (below) +* [Blog](#) (below) +* [Group Website](#) (below) +* [Github](../github/index.md) (separate section) +* [<- Back to **Chairs**](index.md#) + +## Content +Here find all the information on the tools available for running your WG / IG and how to use them + +### Mailing List +Information on mailing lists including how to setup, manage, archives and appropriate behaviour. + +W3C maintains a list of all public mailing lists. You can view this [here](https://lists.w3.org/). + +### W3C Wiki +W3C wiki location, links to info on how to edit, information on how to manage including Posting Markup examples in W3C wikis). + +### Blog +Examples of blogs. + +If you need a blog, wiki, GitHub repository, or mailing list, ask your team contact. + +### Group Website +Setting up a group website, the team members who can help, good examples of group websites. + + + diff --git a/mock/code_of_conduct.md b/mock/code_of_conduct.md new file mode 100644 index 000000000..dadbfcd0a --- /dev/null +++ b/mock/code_of_conduct.md @@ -0,0 +1,9 @@ +# Code of Conduct +## Menu +@todo +* [<- Back to **Home**](index.md) + +## Content +Add Content. + +PWE can add content here. diff --git a/mock/editors/explainer.md b/mock/editors/explainer.md new file mode 100644 index 000000000..a4137e392 --- /dev/null +++ b/mock/editors/explainer.md @@ -0,0 +1,20 @@ +# Explainer Documents +## Menu +* [What is an Explainer Document?](#) (below) +* [Tips on Writing an Explainer Document](#) (below) +* [Good Examples of Explainer Documents](#) (below) +* [<- Back to **Editors**](index.md) + +## Content +Details about Explainer Documents are given below. + +### What is an Explainer Document? +Explainer Documents are an easy to read and understandable document which introduces the specification idea, the goals and a description with examples of how it is supposed to be used. + +The aim of an Explainer Document is to allow the reader to quickly understanf the key points of the specification, without needing to decipher the specification document itself. + +### Tips on Writing an Explainer Document +Add Content. Github and .md guidance. + +### Good Examples of Explainer Documents +Add Content. diff --git a/mock/editors/incubation.md b/mock/editors/incubation.md new file mode 100644 index 000000000..64e3b3f48 --- /dev/null +++ b/mock/editors/incubation.md @@ -0,0 +1,26 @@ +# Incubation +## Menu +* [Preparing for Incubation](#) (below) +* [WICG](#) (below) +* [CG](#) (below) +* [Other Incubation Methods](#) (below) +* [What to do if Incubation fails](#) (below) +* [<- Back to **Editors**](index.md) + +## Content +If you have a new idea or proposal for a W3C Recommendation or group then it is recommended that you take this idea through the process of "Incubation". Incubation is a process where you bring your idea to a special group within the W3C (WICG) to have it reviewed before beginning a new group, or start a Community Group (CG) as a way to show that there is industry support for your idea or proposal. See below for more information on these, and other, methods of incubation. + +### Preparing for Incubation +Add Content. Include what documents to get together, support to gather and how to show code or ideas working in practice. + +### WICG +Add Content. Chris Wilson can add content here. + +### CG +Add Content. + +### Other Incubation Methods +Add Content. + +### What to do if Incubation fails +Add Content. diff --git a/mock/editors/index.md b/mock/editors/index.md new file mode 100644 index 000000000..a365c5c67 --- /dev/null +++ b/mock/editors/index.md @@ -0,0 +1,20 @@ +# Information For Editors +## Menu +* [Incubation](incubation.md) +* [Spec Terminology](terminology.md) +* [Explainer Documents](explainer.md) +* [Document Creation and Tools](tools.md) +* [Rec Track](index.md) (separate section) +* [Using Github](#) (separate section) +* [Testing](testing.md) +* [Reviewing Documents](reviewing.md) +* [List of Mailing Lists](#) (separate section) +* [<- Back to **Home**](../index.md#) + +## Content +One of the main accomplishments at W3C is to write specifications and create standards out of them. While the Working Groups at large are responsible for building consensus on the technical decisions, the editors have the heavy responsibility of transforming these decisions into actual specifications. + +This page tries to gather resources that can help editors do their job: documentation, tools, tutorials, etc. If you know other resources that would benefit editors by being listed here, please inform the W3C Communication Team at w3t-comm@w3.org. + +Note: content from + diff --git a/mock/editors/reviewing.md b/mock/editors/reviewing.md new file mode 100644 index 000000000..01a5ee7d3 --- /dev/null +++ b/mock/editors/reviewing.md @@ -0,0 +1,34 @@ +# Reviewing Documents +## Menu +* [Explainers](#) (below) +* [Group Reviews](#) (below) +* [Horizontal Reviews](#) (below) +* [<- Back to **Editors**](index.md#) + +## Content +All W3C [RecTrack](https://github.com/nrooney/Guide/blob/master/mock/rectrack/index.md) Documents need to be reviewed. This page explains the review process, and how to reach out to the groups in charge of the reviewing for particular topics. + +## Explainers +"Explainers" as a useful precursor to all forms of review, helping people orient themselves to the problem being solved and the proposed solution approach; useful in general, required for TAG review anyway. Good practice to do it sooner rather than later. + +Add Content. + +### Group Reviews +Group reviews occur throughout a RecTrack Document's time on the Recommendations Track. Please see the [RecTrack](https://github.com/nrooney/Guide/blob/master/mock/rectrack/index.md) pages to view when and how to hold RecTrack Reviews. + +### Horizontal Reviews +Horizontal Reviews are when you request a review of another W3C Group. Below is an explanation of these groups and the reviews they will complete for your document. + +### TAG +The TAG will do a general review of your document. They will be looking for technical inconsistencies and alignment with other W3C Recommendations as well as making sure the Document fits with the architecture of the web and supported by W3C. + +To request TAG review ... + +### Accessibility Review +Questionnaire? + +### Privacy Review +The PING group manage a Privacy Questionnaire. Please reach out to (@todo add mailing list) and request a privacy questionnaire. Please complete this for your document and return it to the PING group. + +### Security Review +Questionnaire? diff --git a/mock/editors/terminology.md b/mock/editors/terminology.md new file mode 100644 index 000000000..91d298231 --- /dev/null +++ b/mock/editors/terminology.md @@ -0,0 +1,9 @@ +# Terminology +## Menu +@todo +* [<- Back to **Editors**](index.md) + +## Content +Common specification terminology is explained below. + +@todo diff --git a/mock/editors/testing.md b/mock/editors/testing.md new file mode 100644 index 000000000..5828451e8 --- /dev/null +++ b/mock/editors/testing.md @@ -0,0 +1,16 @@ +# Testing +## Menu +* [Getting Started](#) (below) +* [Web Platform Tests](#) (below) +* [<- Back to **Editors**](index.md) + +## Content +Testing should be a key part of any standards development process. Below are guidelines to help in getting started with Testing. + +Introduce content then redirect to https://web-platform-tests.org/? + +### Getting Started +Add Content. + +### Web Platform Test +https://web-platform-tests.org/ diff --git a/mock/editors/tools.md b/mock/editors/tools.md new file mode 100644 index 000000000..023810317 --- /dev/null +++ b/mock/editors/tools.md @@ -0,0 +1,33 @@ +# Document Creation and Tools +## Menu +* [Style for Group-internal Drafts](#) (below) +* [Github](#) (separate section) +* [ReSpec and BikeShed](#) (below) +* [Pubrules](#) (below) +* [Normative References](#) (below) +* [Legacy Tools](#) (below) +* [<- Back to **Editors**](index.md#) + +## Content +Here find all the information you need on being an Editor for W3C Rec Track Documents and Notes. + +@todo: check all tools carried from here: https://www.w3.org/2003/Editors/ + +### Style for Group-internal Drafts +Take and modify content from and + +### ReSpec and BikeShed +Take and modify content from , + +### Pubrules +(Publication Requirements) and links to related policies (e.g., namespaces, MIME type registration, version management, and in-place modifications) + +Take and modify content from , , , , , and + +Add pubrules checker and other validation tools e.g. html validation, link checker etc. + +### Legacy Tools +e.g. for xmlspec + +### Normative References +Take and modify content from diff --git a/mock/events.md b/mock/events.md new file mode 100644 index 000000000..3ca3d3e83 --- /dev/null +++ b/mock/events.md @@ -0,0 +1,30 @@ +# Events +## Menu +* [Speaking at W3C Events](#) (below) +* [Presenations and Presentation Tools](#) (below) +* [Event Tips and Decorum](#) (below) +* [National and International Holidays](#) (below) +* [W3C Events](#) (below) +* [<- Back to **Home**](index.md) + +## Content +See details on how to prepare and attending W3C Events below. + +### Speaking at W3C Events +Add Content. + +### Presenations and Presentation Tools +Add Content. + +### Event Tips and Decorum +Add Content. + +### National and International Holidays +It's near impossible to plan a meeting and not hit at least one country national holiday. The below helps chairs and meeting planners with understanding those key dates so they can make a decision of what dates may work for meetings and which are definitely not applicable. Please note: if a holiday is listed below a meeting still may be planned over that date; this is just a guideline to assist meeting planners. + +@todo list holidays from round the world. + +@todo add note to how to update. + +### Upcoming W3C Events +Link to https://www.w3.org/participate/eventscal. diff --git a/mock/github/index.md b/mock/github/index.md new file mode 100644 index 000000000..446f76c72 --- /dev/null +++ b/mock/github/index.md @@ -0,0 +1,9 @@ +# Github +## Menu +@todo +* [<- Back to **Home**](../index.md) + +## Content +Re-arrange content from: https://w3c.github.io/ + +Include workarounds to get access to github when there is a problem. diff --git a/mock/images/index.md b/mock/images/index.md new file mode 100644 index 000000000..fce778262 --- /dev/null +++ b/mock/images/index.md @@ -0,0 +1 @@ +Add images to this folder to be included in the new /guide content. diff --git a/mock/images/w3c_home_nb.png b/mock/images/w3c_home_nb.png new file mode 100644 index 000000000..a8cc8c1fd Binary files /dev/null and b/mock/images/w3c_home_nb.png differ diff --git a/mock/index.md b/mock/index.md new file mode 100644 index 000000000..a9d0e2049 --- /dev/null +++ b/mock/index.md @@ -0,0 +1,28 @@ +# /Guide Homepage +## Menu +* [Code of Conduct](code_of_conduct.md) +* [For Chairs](chairs/index.md) +* [For Editors](editors/index.md) +* [For Members and Group Participants](participants/index.md) +* [Staff Portal](#) (not created yet) + +### Generic Info +* [IRC and Meetings](irc_meetings.md) +* [W3C Groups](https://www.w3.org/Consortium/activities) (link to main site) +* [Rec Track](rectrack/index.md) +* [Github](github/index.md) +* [Events](events.md) +* [Legal](legal.md) (link to main site) + +## Content +### Welcome +Welcome to the W3C Guide! Here you'll find information on how to participate in W3C. Have a suggestion on how this guide can improve? Please [raise an issue](#) in our github repo! + +### Hot Links +* [Using IRC & Scribing](#) +* [TPAC / AC](#) +* [Meeting Calendar & Teleconf Details](#) +* [Using Github (link to main [Github](#github) section)](#) +* [Process Doc](#) +* [/TR](#) + diff --git a/mock/irc_meetings.md b/mock/irc_meetings.md new file mode 100644 index 000000000..df5f26a86 --- /dev/null +++ b/mock/irc_meetings.md @@ -0,0 +1,46 @@ +# IRC and Meetings +## Menu +* [What is IRC?](#) (below) +* [IRC Clients](#) (below) +* [Adding, Removing and Managing the Queue](#) (below) +* [Fixing a Mistake](#) (below) +* [RRSAgent](#) (below) +* [Zakim](#) (below) +* [IRC Decorum](#) (below) +* [Scribing](#) (below) +* [Issue Tracker](#) (below) +* [Working with Github](#) (below) +* [<- Back to **Home**](index.md) + +## Content +In meetings IRC is used to take minutes and monitor speaker queues and actions during the meeting. See below for details on how to use IRC. + +### What is IRC? +Add Content. 2 sentence overview and link to wiki page. + +### IRC Clients +Add Content. Recommended clients, w3c web client. + +### Adding, Removing and Managing the Queue +Add Content. q+, q-, ack, q+ with message. + +### Fixing a Mistake +Add Content. s/mistake/fix + +### RRSAgent +Add Content. What it is, how to invite, how to manage. + +### Zakim +Add Content. What it is, how to invite, how to manage. + +### IRC Decorum +Add Content. Include Globalisation issues, /me + +### Scribing +Add Content. How to scribe, ..., tips on scribing. + +### Issue Tracker +Add Content. + +### Working with Github +Add Content. Florian had some ideas here. diff --git a/mock/legal.md b/mock/legal.md new file mode 100644 index 000000000..8ed9e02da --- /dev/null +++ b/mock/legal.md @@ -0,0 +1,18 @@ +# Legal +## Menu +* [Non-Disclosure Agreements](#) (below) +* [Antitrust and Competition Guidance](#) (below) +* [IPR Policies](#) (below) +* [<- Back to **Members and Participants**](index.md) + +## Content +Text + +### Non-Disclosure Agreements +Add Content. + +### Antitrust and Competition Guidance +Add Content. + +### IPR Policies +Add Content. diff --git a/mock/participants/group_types.md b/mock/participants/group_types.md new file mode 100644 index 000000000..8f332a025 --- /dev/null +++ b/mock/participants/group_types.md @@ -0,0 +1,30 @@ +# W3C Group Types +## Menu +* [Working Groups](#) (below) +* [Interest Groups](#) (below) +* [Business Groups](#) (below) +* [Community Groups](#) (below) +* [Horizontal Review Groups](#) (below) +* [TAG and AB](#) (below) +* [<- Back to **Members and Participants**](index.md) + +## Content +Find out about W3C group types below. + +### Working Groups +Add Content. + +### Interest Groups +Add Content. + +### Business Groups +Add Content. + +### Community Groups +Add Content. + +### Horizontal Review Groups +Add Content. + +### TAG and AB +Add Content. diff --git a/mock/participants/index.md b/mock/participants/index.md new file mode 100644 index 000000000..7f34eb702 --- /dev/null +++ b/mock/participants/index.md @@ -0,0 +1,23 @@ +# Informations for Members and Participants +## Menu +* [Types of W3C Group](group_types.md) +* [Join a group](#) (below) +* [Invited Experts](invited_experts.md) +* [Attending Teleconferences](teleconfs.md) +* [Using Github](../github/index.md) (separate section) +* [Making Contribution](#) (needs page) +* [Using IRC & Scribing](../irc_meetings.md) (separate section) +* [Mailing Lists](mailing_lists.md) +* [Using W3C Wiki](#) (separate section) +* [Edit your contact information or affiliation](#) (below) +* [<- Back to **Home**](../index.md#) + +## Content +### Join a group +AC member to add to group, see also [Invited Experts](invited_experts.md) + +### Using W3C Wiki +[Chairs section](../chairs/tools.md#) also has this - split out into own section? + +### Edit your contact information or affiliation +Add Content. diff --git a/mock/participants/invited_experts.md b/mock/participants/invited_experts.md new file mode 100644 index 000000000..15b5b2eda --- /dev/null +++ b/mock/participants/invited_experts.md @@ -0,0 +1,15 @@ +# Invited Experts +## Menu +* [Mailing List](#) (below) +* [<- Back to **Members and Participants**](index.md) + +## Content +Invited Experts to W3C can find information below to aid in their participation at W3C. + +@todo Florian could add content here (or pass to a contact) + +### Becoming an Invited Expert +Text on how to become an invited expert. + +### Subtitle +Mailing list details. diff --git a/mock/participants/mailing_lists.md b/mock/participants/mailing_lists.md new file mode 100644 index 000000000..3af193449 --- /dev/null +++ b/mock/participants/mailing_lists.md @@ -0,0 +1,38 @@ +# Mailing Lists +## Menu +* [Finding your group Mailing List](#) (below) +* [Mailing List Archives](#) (below) +* [How to Reply and "Top Posting"](#) (below) +* [Github and Mailing Lists](#) (below) +* [Plugins for Outlook and other Mail Clients](#) (below) +* [Advice on Decorum on Mailing Lists](#) (below) +* [Complaints and Issues](#) (below) +* [<- Back to **Members and Participants**](index.md) + +## Content +Mailing lists are used by W3C groups to discuss work, organise meetings and drive deliverables forward. Learn how mailing lists work and decorum guidelines below. + +### Finding your group Mailing List +To find your group mailing list visit the group homepage... + +To find all group mailing lists... + +### Mailing List Archives +All W3C groups have a mailing list archive which will hold all mails sent on the list... + +### How to Reply and "Top Posting" +W3C participants often + +### Github and Mailing Lists +Many groups use Github to manage their documentation and deliverables. Github may send automated emails to the group mailing list. To respond to these... + +To remove yourself from the Github mails... + +### Plugins for Outlook and other Mail Clients +Outlook and some other mail clients do not format reply emails well and make it difficult for participants to reply or follow inline-replied emails. Plugins can help... + +### Advice on Decorum on Mailing Lists +Add content. + +### Complaints and Issues +If you have any issues or complaints ... diff --git a/mock/participants/teleconfs.md b/mock/participants/teleconfs.md new file mode 100644 index 000000000..f851c2491 --- /dev/null +++ b/mock/participants/teleconfs.md @@ -0,0 +1,27 @@ +# Attending Teleconferences +## Menu +* [Webex and Other Services](#) (below) +* [IRC](#irc) (below) +* [Speaking and Adding Items to an Agenda](#irc) (below) +* [Calendar Invites](#calendar-invites) (below) +* [<- Back to **Members and Participants**](index.md) + +## Content +Find information on attending group teleconferences below. + +### Webex and Other Services +The W3C system for teleconferences is Webex. Prior to a teleconference meeting group members should receive Webex details from the chair or team contact. Webex can be joined via the web, via the Webex app or via the phone. Webex has dial in numbers for many countries around the world, see [here](#) for a list of the dial-in numbers. + +#### Other Systems +Sometimes a group will opt to use another teleconference system. This may be because the chair has use of a system at their workplace which they prefer to use. W3C allows this, but if any group members have as issue with this please let the chair or team contact know so they can encourage the chair to move to the Webex system. + +### IRC +@todo Add content and link to main IRC Page. Ask Nigel if there's a good IRC guide that he's seen targetted to participants. + +### Speaking and Adding Items to an Agenda +To speak in a W3C teleconference add yourself to the queue by typing "q+" in IRC. The chair will see that you have been added to the speaking queue, and when it is your turn to speak the chair will call on you to speak. + +If you wish to have an item added to the agenda please email your group mailing list previously, or let yuor chair know at the beginning of the meeting. Different chairs run meetings in different ways, so chairs may encourage you to take your item to the mailing list or wait till a later meeting. If you have any issues with these decisions feel free to speak to your team contact. + +### Calendar Invites +Calendar invites are rarely sent for W3C meetings. It is up to the participant to add the invite using their calendar tool when they receive an email from their chair / team contact regarding the next group meeting. If you have issues with the process please email your group team contact. diff --git a/mock/rectrack/index.md b/mock/rectrack/index.md new file mode 100644 index 000000000..cfe61c095 --- /dev/null +++ b/mock/rectrack/index.md @@ -0,0 +1,18 @@ +# Recommendations Track +## Menu +* [Rec Track Explained](#) (below) +* [Recommendation Track Readiness Best Practices](#) (below) +* [<- Back to **Home**](../index.md) + +## Content +This page gives an understanding of the W3C "RecTrack" or Recommendations Track. + +### Rec Track Explained +Take and modify content from + +### Recommendation Track Readiness Best Practices +Add Content. + +Include best practice advice to accompany all proposals for normative changes with tests that can be contributed to test suites, since they will be needed to exit CR anyway, and they help clarify exactly what the spec text needs to say. + +