On Sat, Nov 7, 2015 at 4:01 PM, Mike Dusenberry <[email protected]> wrote:
> I think that hosting the "overview" website (basic info on the project, > link to the GitHub code repo, binary releases, snapshots of docs for the > releases, etc.) in a separate Git repo should be fine since it's not tied > to the core codebase. Exactly. > For our "docs" (guides, language references, API > Javadocs, etc.), I vote that we keep them in their current location within > the SystemML Git code repo. When we cut a release, we can just compile a > snapshot of the docs for that release and publish to the "overview" > website. Yes, and this would also include other things such as JavaDocs, etc. > For the current, bleeding-edge version, we can just continue our > current practice of automatically deploying a subtree of the "docs" folder > from the master branch to the "gh-pages" branch and let GitHub render it > (as is the case for http://sparktc.github.io/systemml/). This should be > beneficial in that it keeps the docs, which are intrinsically tied to the > current version of the codebase, collocated with the code. Also, since the > "docs" folder is just a Jekyll project with Markdown, images, etc., we > won't have any compiled artifacts (HTML, etc.) in the repo. > > This is what we need to check if still going to work, as we will be moving to the Apache Infrastructure and github becomes only a mirror of the code, and not the cannonical repository. But the workflow idea is exactly this, with the exception that "gh-pages" might be the project website via svnpubsub. > - Mike > > > On Sat, Nov 7, 2015 at 9:54 AM, Luciano Resende <[email protected]> > wrote: > > > Some follow-ups below: > > > > On Sat, Nov 7, 2015 at 10:15 AM, Luciano Resende <[email protected]> > > wrote: > > > > > I have started to put together a strawman for the SystemML website > using > > > Jekyll to generate the static version of the site. If you want to take > a > > > look at the alpha version, please check the link below: > > > > > > http://people.apache.org/~lresende/system-ml/website/ > > > > > > My goal is to have some basic info available and publish the first > > > version, and continue to work as a team to make it better. > > > > > > Some decisions we need to make : > > > - Where should the source for the website go > > > -- own repository versus > > > -- collocated with the systemml source code main repo > > > > > > > > Based on previous discussion [1] and some best practices from other > > projects, I am planning to create a git repository for the SystemML > > website, and use svnpubsub to publish the website. > > > > The git repository could have been just a folder in the SystemML > > repository, but I was thinking that it won't match release cycles, etc > and > > always have to be updated after the fact of a release, so a separate repo > > seemed better for me. Please let me know what are your thoughts. > > > > > > > - How are we going to integrate the project artifacts, such as docs, > > > javadocs, etc which needs to be versioned and accessible by version > > > -- at the time of the release, we publish a snapshot to the website > ? > > > -- and how we publish all changes to the "current" documentation ? > do > > > we actually need this ? > > > > > > > > > > > Based on the comment above, with svnpubsub, we would be able to store > these > > extra and versioned projects artifacts in svn, and link them from the > > website code. > > > > > > > > > > Anyway, please provide your feedback, and unless I get some very bad > > > feedback, hopefully we will get this published by monday. > > > > > > > > > [1] > > https://www.mail-archive.com/[email protected]/msg51414.html > > > > -- > > Luciano Resende > > http://people.apache.org/~lresende > > http://twitter.com/lresende1975 > > http://lresende.blogspot.com/ > > > -- Luciano Resende http://people.apache.org/~lresende http://twitter.com/lresende1975 http://lresende.blogspot.com/
