Skip to content

direct link to this doc on GH for easier discovery #317

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

direct link to this doc on GH for easier discovery #317

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0b69c5
direct link to this doc on GH for easier discovery
tantek Apr 9, 2025
5d3d47d
sentence terminator
tantek Apr 9, 2025
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
3 changes: 2 additions & 1 deletion process/cg-transition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ title: How to transition work from a Community Group to a Working Group
toc: yes
---

From time to time a Community Group that has been [incubating a technology](../incubation.md) seeks to advance it to the W3C Recommendation track in a Working Group. Our goal through this document is to ease that transition.
From time to time a Community Group that has been [incubating a technology](../incubation.md) seeks to advance it to the W3C Recommendation track in a Working Group. Our goal through this document is to ease that transition.
This [document is on GitHub](https://github.com/w3c/guide/blob/main/process/cg-transition.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document already links to github at the end of it:
[[
This document lives in GitHub, where changes can be tracked and pull requests are welcome. Feedback and comments are welcome. Please use GitHub issues.
]]
https://www.w3.org/guide/process/cg-transition.html

Adding yet another link just increases the maintenance cost imho.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing link to GitHub is a usability error and a barrier to contribution.

It links to the top of the Guide repo, which is equivalent to linking to a home page and expecting someone to dig through two levels of links to find an actual document.

We have a practice in charters, specs etc. of "document lives in GitHub" link text actually linking directly to the document to make it easier and more accessible for especially new participants to find the place to contribute to a resource, rather than the "general area where if you explore for a while you might find it". I believe it is worth having such direct links in the Guide as well.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing link to GitHub is a usability error and a barrier to contribution.

That comment goes beyond the scope of one single page in the Guide. It's applicable to all pages in the Guide. So, imho, either this pull request scope covers the scope of the entire guide, or it should be closed and a separate issue should be filed against the entire Guide.


## Preparation

Expand Down