I definitely prefer #1 precisely because of the versioning argument you raise.
-- Matthew Gaudet
8200 Warden Avenue
(905) 413-3722
----- Original message -----
From: Mark Stoodley/Toronto/IBM@IBMCA
Sent by: omr-dev-bounces@xxxxxxxxxxx
To: omr-dev@xxxxxxxxxxx
Cc:
Subject: [omr-dev] OMR web site
Date: Tue, Aug 16, 2016 10:55 AM
Some intrepid folks at IBM have put together a web site for the OMR project and are now considering where to put it. There is one important requirement to be aware of, and then basically one key decision for us to make but I'd like to open this up to anyone to provide input for us.
The Eclipse foundation requires us to host the main web site at www.eclipse.org. There is a git repository for us at Eclipse where we could maintain the site, but I would prefer to keep our GitHub repository as the single source for all our project material including documentation and web site. There is an established mechanism for holding docs at GitHub but rendering on www.eclipse.org(see https://bugs.eclipse.org/bugs/show_bug.cgi?id=463327for details if you're interested).
We are allowed to put supplementary information at the GitHub web site that would come from gh-pages, if we want to.
I see a couple of main options here:
1) put all the web site materials, including documentation, into a directory (website?) in our master branch
- do not use gh-pages branch
2) put everything into the gh-pages branch
- github.io site renders our documentation
- main web site rendered at Eclipse, linking to our github.io site for docs
My vote is for #1 because we will then get a versioned web site automatically (when we ship a release, the documentation and web site will be automatically versioned along with the code) and we can more easily maintain documentation updates at the same time as code checkins in the same pull requests.
#2 would allow us to leverage more of the GitHub infrastructure that other open source projects are using. Most of our updates will be to documentation rather than the web site, I would expect, but it's still a second location where the documentation resides compared to where the code resides. Even if we do #2, we still need to have our web site at the www.eclipse.organd maintain it.
I think the benefits in #1 far outweigh what we lose in not doing #2, but maybe I haven't imagined all the benefit to #2. Thoughts?
I'll leave this open until Monday August 22 unless the discussion is still progressing effectively.
|
| |
| Mark Stoodley | 8200 Warden Avenue | |
| Senior Software Developer | Markham, L6G 1C7 |
| IBM Runtime Technologies | Canada |
| Phone: | +1-905-413-5831 | | |
| e-mail: | mstoodle@xxxxxxxxxx | | |
We cannot solve our problems with the same thinking we used when we created them - Albert Einstein |
| |
| |
