Re: [omr-dev] OMR web site

["Mark Stoodley" <mstoodle@xxxxxxxxxx>]

Ok, there was only one response on the
incubators list, and that was a project that maintains its documentation
and web site in different repositories (actually, they seem to have lots
of repositories). They have had some challenges keeping things up to date
when code changes, but they only have one (the current) version of the
documentation available from the web site.

The concerns I hear seem to revolve
around repository bloat and downloading things you don't really want. On
the flip side, there is a desire to be able to keep the documentation "connected"
with the code it documents. I think that will be important since language
communities usually cannot afford to move their users too quickly and if
we want to be at the center of a group of language communities, we need
to be able to satisfy their use cases. As an example, you can find the
official Java 6 API documentation (where Java 6 was released in 2006!!)
even though the Java community is currently deeply embroiled in the development
of Java 9. Maybe we don't need to plan for that degree of longevity, but
I think it's a reasonable expectation for us.

The compromise solution here would be
to store our main web site at the Eclipse web site git repository, which
already exists and is already the right place for the main Eclipse OMR
web site to be hosted. That keeps the main web site artifacts out of our
source code repository. At the same time, we store the main project documentation
in the source code repository in a directory alongside the source code
so that it can be versioned just like the code can be.

In this scenario, we still need a mirroring
job to pull the documentation sources from our GitHub repository to be
merged together with the Eclipse web site.

If there are no objections by Thursday
August 25, I would like to start implementing this plan (along with any
suggested refinements).

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

From:      
 Robert <rwy0717@xxxxxxxxx>
To:      
 omr developer discussions
<omr-dev@xxxxxxxxxxx>
Date:      
 2016/08/17 11:29 AM
Subject:    
   Re: [omr-dev]
OMR web site
Sent by:    
   omr-dev-bounces@xxxxxxxxxxx

---

"Dorra Bouchiha" <dorrab@xxxxxxxxxx>
writes:

> The size of the website directory is 3.2M
>
> The images sub directories are ~1M and the fonts dirs are ~1.2M
>

If we really are concerned with checking in binaries, maybe git large
file storage is something we want to look into.

https://git-lfs.github.com/

Although personally, I doubt the repository bloat is worth the added
complexity.

- Robert
_______________________________________________
omr-dev mailing list
omr-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/omr-dev