While Volute has a hierarchical structure (WG/Document), Github provides no further hierarchy. Therefore, each document will go into a separate repository directly under the ivoa-std organization.
$ wget https://raw.githubusercontent.com/ivoa-std/volute-migration/master/convert.sh $ chmod +x convert.sh
$ ./convert.sh dal/ADQL
This will create a subdirectory ADQL containing the git repository for the document from volute. Only the trunk is converted; branches and tags are left out. The commit authors are converted with the file volute-users.txt.in (slightly scrambled to confuse email scrapers).
I would then recommend to create tags for the versions (WD, PR, REC) of the standard, in the syntax:
v0.1_20141008 |
Internal Draft |
v1.0_20150515-note |
Note |
v2.1_20170923-wd |
Working Draft |
v2.1_20180112-pr |
Proposed Recommendation |
v2.1 |
Recommendation |
These can be converted into github "Releases" which allow add PDF, HTML and other files, making it easier to have everything well-structured in one place.
This script will also add the recommended CC-BY-SA 4.0 license to the repository. This license lets others remix, tweak, and build upon your work even for commercial purposes, as long as they credit you and license their new creations under the identical terms.
Now create a repository on https://github.com/ivoa-std/. This requires that you are in the ivoa-std organization. Then push the converted directory (the example uses ADQL as repository):
$ cd ADQL $ git remote add origin [email protected]:ivoa-std/ADQL $ git push --set-upstream origin master --tags
The ivoatex package should be included as a git submodule:
$ cd ADQL $ git submodule add https://github.com/ivoa-std/ivoatex $ git commit -m "Add ivoatex submodule" $ git push
The git module does not support Subversion tags. They must be removed from the LaTeX file:
$ sed -i '/^\\SVN\$/d' -i ADQL.tex $ git commit -m "Remove supported SVN tags" ADQL.tex $ git push
Keep in mind to use the --recurse-submodules
option when cloning
the repository.
To avoid confusion which repository to use for further development, it is strongly recommended to replace the document directory on volute with a README documenting that the repository was moved to github.