Site proxy management

This wiki page contains notes as we develop a strategy that will enable us to have w3.org links all files maintained on GitHub. The content is expected to constantly change as the strategy is developed and refined.

1 A file that is only on GH and needs a proxy URL but is in a directory that is the same as one on CVS that has related files.

Solution 1: Assign a proxy URL that starts with www.org/International/gh/ which maps to github.io/i18n-drafts/

Eg. Language enablement. https://w3c.github.io/i18n-drafts/getting-started/languagedev.en Make the proxy URL https://www.w3.org/International/gh/getting-started/languagedev.en

Solution 2: Move the file to a different directory on GH, such as github.io/i18n-drafts/nav. Make the proxy URL w3.org/International/nav/ Replace the former page on github with a pointer to the new location.

Eg. Language enablement. https://w3c.github.io/i18n-drafts/getting-started/languagedev.en Moved to https://w3c.github.io/i18n-drafts/nav/languagedev.en Make the proxy URL https://www.w3.org/International/gh/nav/languagedev.en

Solution 1 is easiest to implement, but means that some of the files in a URL path have the additional /gh/ string, and it's necessary to remember which ones if you are typing URLs. Solution 2 allows for a cleaner

Files affected: - Language enablement. https://w3c.github.io/i18n-drafts/getting-started/languagedev.en

2 A top level page exists only on CVS, but needs to be managed on GH.

Eg. Ask for help or information https://www.w3.org/International/about

Create a directory on GH ('nav') and copy the file there. Replace the content of the CVS file with a pointer to https://www.w3.org/International/nav/about Set up a proxy from www.org/International/nav/ to github.io/i18n-drafts/nav/

Files affected:

• Ask for help or information https://www.w3.org/International/about

3 Create a proxy link to a task force 'home page', which is the top level of a GH repo.

This is currently difficult for some task forces because the proxy tool only allows links to github.io, not github.com.

For some repos it is possible to link directly to the README file. For example, w3.org/International/groups/taskforces/sealreq could link to https://w3c.github.io/sealreq/. It would be necessary to add highly visible links to each of these README files so that the user can then get to https://github.com/w3c/sealreq and would probably also be helpful to add clearly visible links to the issue page overview and the wiki overview page (if there are wiki pages).

It would not be possible to use a proxy URL to link to the issue list, though this is not really appropriate anyway. Also it would not be possible to use a proxy URL to link directly to a wiki page.

For some such 'home pages' however, this is more difficult because there is an index.html file at the top level. Eg. https://github.com/w3c/alreq and its README cannot have the proxy w3.org/International/groups/taskforces/alreq because it would retrieve https://w3c.github.io/alreq/ (the main document).

One possible solution to this would be to move the index.html file to a subdirectory, however i think this would cause problems for archived published versions of the document in TR, which point to https://w3c.github.io/alreq/ for the ED.

It may be a good rule of thumb to always avoid putting an index.html file at the top level of future repos.

4 A wiki page is used for some content.

Wiki pages will be converted to regular pages, wherever possible, hosted on GitHub and linked to by proxy URLs using methods described earlier.