Warning:
This wiki has been archived and is now read-only.

Github

From Digital Publishing Interest Group
Jump to: navigation, search

Information about the dpub github repo

Core Repos

(This is a slightly updated versions of a previous setup, sorry for the confusion!)

The various documents (or closely related documents) would each run in their own github repository, which means that the developments may happen independently of one another. The expectation is that there would be one repository per task force. All of them are under the "W3C" project, the repositories are publicly visible, but direct editing (ie, contributing to the repository content) is restricted. To become a contributor, you should create a github account and send your github ID to Ivan or Thierry. (Alternatively, you can, in true github fashion, "fork" the repository, do your own changes, and send a "pull request" to incorporate the) document into the main repo.

There is a Documents Repositories Index with the current repositories.

Paged View

The downside of a repository on github is that an HTML file will always appear in source. See, eg, https://github.com/w3c/dpub-pagination/blob/gh-pages/index.html. Even if the "raw" version is used, like https://raw.github.com/w3c/dpub-pagination/gh-pages/index.html, what is displayed is the source code in HTML and not what one would like to see on a browser. The usual approach to handle that is to set up a separate "paged view" of the repository, in this case http://w3c.github.io/dpub-pagination/. This gives a HTTP view of the content; the same file as above can be accessed served as HTML (and hence properly displayed.

Tools

Git can be intimidating (but there is at least a help online (that page also includes some Mac and Windows specific information), and a bunch of info on the Web on git in general (e.g., GIT documentation. But there are some handy tools around that hide most of the complexities see, eg, list of graphical interfaces. One of the very popular tools is SourceTree that really hides most of the complexity and one can get by with pull-commit...

B.t.w., the ProGit Book is a good source for information. It is readable on-line, but is also downloadable in ePub.

Further reading

There is a separate W3C Guide for Github. You should be able to edit if you find things to change or add; alternatively, talk to the staff contacts!