strong +1 In addition to keeping the docs updated in sync with the patches, and helping us avoid two source control systems, this will also allow automated integration with https://readthedocs.org/, to make the docs immediately available online, versioned and searchable.
Gwen On Fri, Feb 6, 2015 at 8:05 AM, Joe Stein <joe.st...@stealth.ly> wrote: > this looks like it might help us too with getting the release documentation > content/changes along with code & test contributions in patches without the > extra step with the site in the commits with svn > > ---------- Forwarded message ---------- > From: Dave Lester (JIRA) <j...@apache.org> > Date: Tue, Dec 23, 2014 at 5:30 PM > Subject: [jira] [Created] (AURORA-985) Move Aurora website source to > subdirectory of git repo > To: iss...@aurora.incubator.apache.org > > > Dave Lester created AURORA-985: > ---------------------------------- > > Summary: Move Aurora website source to subdirectory of git > repo > Key: AURORA-985 > URL: https://issues.apache.org/jira/browse/AURORA-985 > Project: Aurora > Issue Type: Task > Reporter: Dave Lester > Assignee: Dave Lester > > > Currently the source of the Aurora website lives in subversion; static > files generated by Middleman live in a /site/publish/ folder that renders > online at aurora.incubator.apache.org. However, since documentation is > rendered on the website (and included in the /docs folder of the codebase) > it requires they be copied from git to svn whenever a change is made. > > This ticket proposes to move the contents of the /site/source/ folder > (currently on subversion) to git, and to be part of the same repository > where the aurora codebase lives. > > This change would make it possible to: > 1) avoid a `git clone` of docs from the git repo to subversion > 2) easily vet documentation changes to the main Aurora codebase by seeing > how they will render on the website. Having them in two separate repos > currently makes this cumbersome, and encourages folks to ship documentation > without verifying what it looks like. > 3) simplifies the process of committing documentation changes to the > website by making it possible w/in the same repo as the full codebase > > > > -- > This message was sent by Atlassian JIRA > (v6.3.4#6332) >
