Task for SC managers

SC Managers,
We have a few tasks for you to do to help with the updated structure of the GitHub repo. Even though the discussion continues about possible changes to the process and whether to allow forking the discussion to use other tools such as Google Docs or wikis, the WCAG 2.1 source files will be in GitHub for publication and the following changes need to happen for that.

So, here’s what we need – I expect that this will take you 2-5 minutes per issue. If you run into difficulty, please don’t feel hesitant in reaching out to me or Michael for help.

The “figure it out yourself” version of the instructions are to look at what I did for Issue 2 (https://github.com/w3c/wcag21/issues/2) and do the same for your issue, being careful to select the right branch for the URI’s you use (see step 2 in the longer instructions).

The “step-by-step” version (I’ll use Issue 2 for “Change of Content” as an example throughout the steps):

  1.  Open your issue in a browser window- you will need to refer to this page and eventually make some edits.
  2.  In a different tab or browser window, identify the branch for your issue at https://github.com/w3c/wcag21. (For Issue 2 it is “change-of-content_ISSUE-2”). Switch to that branch.
  3.  Go to the guidelines directory and then into the SC directory, and then into the “21” directory.
  4.  Find the HTML file that matches the first part of the branch name. Click on that file and copy the URI of the page to a separate document.
  5.  Check that the URI you copied contains the correct branch. (for Issue 2, the URI is https://github.com/w3c/wcag21/blob/change-of-content_ISSUE-2/guidelines/sc/21/change-of-content.html – note that after the “blob” part of the URI the URI includes a match to the correct branch name).
  6.  Look at the issue you are managing (in the other browser window) - if there are definitions being defined with the SC proposal, continue to the next step. If not, skip to step __.
  7.  Back up out of the “21” and “SC” directories, and go into the “terms” directory and into the “21” directory.
  8.  Find the HTML file (or files if the proposed SC has multiple definitions) and copy the URI for each term into a separate document.
  9.  Once you have the URIs for the SC and each definition, you can close the browser window for the branch but keep the issue window open. We are ready for the changes to the issue.
  10. You should have permissions to edit the original issue description. We hope that this will be the last time we do this. Click on the pencil icon at the top and right side of the issue
  11. On the first line of the issue description put:
# Current versions of SC and Definitions
  12. On the second line you are going to use the Github syntax for links to provide links to the SC -  the best thing to do is copy and paste this example and then modify it. Paste the following:
- [SC for viewing](https://rawgit.com/w3c/wcag21/change-of-content_ISSUE-2/guidelines/sc/21/change-of-content.html) | [SC for editing](https://github.com/w3c/wcag21/blob/change-of-content_ISSUE-2/guidelines/sc/21/change-of-content.html)
  13. Now edit the two URI – the second one is for the link to the editing version of the SC and this is the first link you copied in step #4 above. The URI for the “SC for viewing” is the same URI except that “github.com” is replaced with “rawgit.com” and the “blob/“ is removed from the URI.
  14. On the third line (and possibly on additional lines if there is more than one definition) we will provide the definition links. Again, copy and paste the following and then edit the URI as in step #13, except that you will use the link or links to the definitions that you copied in step #8.
- [Change of Content definition for viewing](https://rawgit.com/w3c/wcag21/change-of-content_ISSUE-2/guidelines/terms/21/change-of-content.html) | [Change of Content definition for editing](https://github.com/w3c/wcag21/blob/change-of-content_ISSUE-2/guidelines/terms/21/change-of-content.html)
  15. Finally, on the next line paste the following and replace the “#change-of-content” with the file name from the URL copied in step #4 (for issue 2 it would be "change-of-content.html” but strip off the “.html”. This will provide a link to the proposed SC in the document in context.
- [SC in full draft guideline](https://rawgit.com/w3c/wcag21/change-of-content_ISSUE-2/guidelines/#change-of-content)
  16. Click “update comment”.
  17. Test your links to make sure they work.

If this is too confusing or you are otherwise having trouble, please try at least to email the links copied in steps 4 and 8 to me and Michael.

I will next send an email on editing the SC if there is no content there yet…


Andrew Kirkpatrick
Group Product Manager, Standards and Accessibility


Received on Wednesday, 15 March 2017 16:58:18 UTC