w3c / onboarding

A tool to send the facility map to newcomers in a group

A tool to send a welcome message to newcomers in a group

This tool listens to a W3C webhook and sends emails to new participants in a Working/Interest Group upon joining.

Groups can have a customized welcome message sent automatically, by adding their template to this repository's template directory, using the group's type/shortname as file name (e.g. wg/css for the CSS Working Group).

Otherwise the default template will be used. Team contacts and chairs will be Cc'd.

No message is sent to Community/Business Groups new participants by default, but if the system finds a customized message for a CG/BG in the template directory, that message will be sent and chairs of the CG/BG will be Cc'd.

Templates may use the Twig syntax to include some W3C group data to customize the message. Information comes from the W3C API (see e.g. https://api.w3.org/groups/wg/css), you can use name, description, shortname, type e.g.:

• {{ group.name }} will be replaced by the group's name, e.g. "Cascading Style Sheets (CSS) Working Group"
• {{ group.shortname }} will be replaced by the group's shortname, e.g. "css"

It is also possible to include links e.g.:

• Group homepage: {{ group._links.homepage.href }}, e.g. "https://www.w3.org/Style/CSS/"
• IPR status page: {{ group._links.pp-status.href }}, e.g. "https://www.w3.org/groups/wg/css/ipr/"

Of course you may use completely basic URLs without any Twig code at all!

onboarding's Issues

Documentation clarifications

To elucidate "the W3C identifier for your group", could you provide a link to the list of those for existing groups? Or otherwise explain what is meant? (Many just add the word "numeric"?)

Is this also what is meant by "your group's id"? (Glancing at one of the Privacy IG's specs, it's not clear what you mean.)

Numeric IDs

Two points:

1) Finding the pesky numeric id.

From the FAQ:

I don't know my group's id, how do I find it?

It is the same numeric id that you use for links to Patent status in specs (links from https://www.w3.org/2004/01/pp-impl/).

That used to be true, but now they have sensible names like https://www.w3.org/groups/wg/audio/ipr

you can find it in other tools e.g. https://www.w3.org/PM/Groups/browse.html (choose your group in the drop-down menu

That page seems to be broken, the dropdown has a single entry {$name}. Maybe an API changed or a service needs to be restarted?

or https://w3c.github.io/Guide/participant/group.html.

Also broken

2) Advisability of numeric ids

This directory listing is fairly off-putting. I would far rather see a list of actual WG names like we use everywhere else.

CEPC link

CEPC link is now:
https://www.w3.org/policies/code-of-conduct/

A general pull request to update that link seems the most efficient.

fyi @koalie

Revamp the default welcome message

This is a more generic issue about crafting a better default message for WGs and IGs, possibly
referring to the /groups/.../... uris instead of https://w3c.github.io/Guide/participant/group.html?gid=...
(this issue is a followup to issue #38 )

Feel free to give ideas.

It is also possible to discuss a default message for all CGs.

Possible to include more info in the text of the email?

Thanks for this onboarding flow! A few editorial comments in #2

Would it be possible to include some preview of the generated "facility map" in the email itself? I recognize that it's better to send people to the dynamically generated page, but for people who don't automatically click links in email, or have email available for more ready reference and search, can we include at least the topic headers that will be shown there?

group.shorttype

it would be nice to write something like:
https://auth.w3.org/?url=https://www.w3.org/groups/{{ group.shorttype }}/{{ group.shortname }}/calendar

Enhanced contextual information

I would like to see additional information from the W3C API available to templates for this message. Information about the person to whom the message is being sent would make it possible to greet them by name, provide different information for Invited Experts vs Member nominations, etc. If this is already possible, additional documentation about how it is done would be appreciated, as the current documentation only refers to group information that isn't contextual to the specific person.

mention CEPC In every welcome message

It would be a good idea to include a reference to CEPC in every welcome email

What happens when a group closes?

Hi @caribouW3

Do chairs/team contacts need to keep track of their automatic onboarding trigger in the case that the group (or community/business group) closes? or it is there a report sent elsewhere about a discrepancy that causes someone on the team to remove the no longer necessary trigger?