Jump to content

Key Resources and Links

From Accessible Platform Architectures Working Group

FAST & Horizontal Reviews

Key APA Pages

Meeting Logistics

Task Force Resources

Adapt

COGA

Pronunciation

Research Questions (RQTF)

GitHub Help & Tips

Linking your GitHub and W3C accounts

In order for us to be able to assign actions to you, please ensure that your GitHub and W3C accounts are linked, using the form at: https://www.w3.org/users/myprofile/connectedaccounts

Help info on using GitHub

W3C uses GitHub in two main ways:

  • Developing and managing changes with specifications/documents, via GitHub, and other tools such as text editors.
  • Gathering feedback, and performing horizontal review, via the Issues feature on the GitHub web site.

Most people interacting with W3C - and anyone primarily working on horizontal review - will only need to interact with us via the Issues feature on GitHub.com; everything can be done via the web, and you'd only need to be signed in to actual file issues.

We have a process for performing horizontal review, which is being revised at the moment.

In general, GitHub's help info on how to work with Issues may be helpful: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues

HTML previews for Pull Requests

When making a Pull Request (PR) that updates an HTML file on GitHub, it’s possible to get a preview of how the HTML file will look with those changes included, so you can read it as if it was already published on the web. This means that people who reviewing the Pull Request don't need to interpret GitHub’s markup-level difference view. We recommend including a preview URL in your Pull Request's description, as well as a pointer to the current version of the document, so people can easily compare the two.

The format for the URL that will give you a preview is: 

http://raw.githack.com/w3c/<repository>/<pull-request-branch>/<file-path>

You need to fill in the following details:

  • <repository> is the name of your specific repository, e.g. “adapt” or “maturity-model”
  • <pull-request-branch> is the branch you’re working on. If you aren’t sure what it is, you con find it by visiting the Pull Request’s page on GitHub’s web site. The Pull Request’s branch name is displayed near the top, where it says “<user> wants to merge <n> commits into main from <pull-request-branch>”
  • <file-path> is where the file being updated is located within the repository or branch. This is only needed if the file is not in the root directory of the repository, or if it’s not called “index.html” (if the file is called “index.html”, you can omit that part).

Note 1: You can add a fragment link to the end of the preview URL in the normal way, in order to link to a specific section of the document, e.g. #introduction.

If the document on which you’re working is called “index.html” and is directly inside the repository, then the preview URL will be just: 

http://raw.githack.com/w3c/<repository>/<pull-request-branch>/

Note 2: After a Pull Request is merged, it’s common practice to remove the associated branch. If this happens, the preview URL will no longer work. This is no big deal, but just make sure that you don’t share preview URLs in places where a stable reference to a particular version of the document is required.

Example: Maturity Model

The latest version of the main document can always be found here:

https://w3c.github.io/maturity-model/

The branch used by Pull Request #84 was called “enhance-terms”, so the preview URL for that branch was:

http://raw.githack.com/w3c/maturity-model/enhance-terms/

Retrieved from "https://www.w3.org/WAI/APA/wiki/index.php?title=Key_Resources_and_Links&oldid=4299"