Feel free to do it per-file if you want. Looks good to me On Mon, Oct 24, 2016 at 4:14 PM, Balazs Donat Bessenyei <bes...@cloudera.com > wrote:
> I have commenced moving the Developer Section to the git repo. > > There is a WIP pull request available at https://github.com/apache/ > flume/pull/77 > > I'm planning to add more e-mail templates to the HowToRelease.md and > commit all docs in a single commit, but reviews and comments are > welcome in the meanwhile. > > > Thank you, > > Donat > > On Fri, Oct 21, 2016 at 6:07 PM, Mike Percy <mpe...@apache.org> wrote: > > Thanks, Donat. +1 on moving the docs. > > > > Regarding the web site source code, it can reside in svn or git however > it > > should continue using the standard ASF site infrastructure [1] for > hosting > > content which consists only of static rendered HTML content. Our options > > for pushing that rendered HTML are either svnpubsub[2] or gitpubsub[3] > > which are basically the same thing - commit HTML and it gets pushed live > to > > the web site. > > > > If someone wants to redesign the site or improve the site template, I > would > > certainly welcome that. > > > > As a comparison point with another ASF project I am involved in, on > Apache > > Kudu we use the software used for GitHub pages (Jekyll) to render the > site. > > The web site source code is in the gh-pages branch in Git [4]. The site > is > > mostly written in Markdown and we wrote a script [5] that locally renders > > the site to static HTML content and checks in the rendered content to the > > Kudu gitpubsub repository [6]. > > > > In Flume, we basically do the same thing but but instead of Jekyll we use > > Sphinx and the site source code is primarily ReStructuredText. The site > > lives in its own svn repo [7]. We push rendered HTML tent to an svnpubsub > > repository for Flume [8] which is controlled by the ASF CMS [9]... IIRC, > > the CMS takes care of invoking the rendering part instead of having a > local > > script to do it. This is kind of documented in the How to Release guide > for > > Flume [10]. > > > > If someone just wanted to change the look & feel of the web site they > could > > easily do it with a little HTML/CSS knowledge and some reading up on > > Sphinx. The web site template could be changed to something nicer (it's > > using some kind of stock template right now). The existing .rst content > > would not need to be modified at all, probably. > > > > If someone wanted to switch the whole web site to some other system, like > > Jekyll, obviously it's a bigger change but if they were determined then I > > don't think anyone would try to stop them, assuming it's an improvement! > > > > Hope this helps, > > Mike > > > > [1] https://www.apache.org/dev/project-site.html > > [2] http://svn.apache.org/viewvc/subversion/trunk/tools/ > > server-side/svnpubsub/ > > [3] https://www.apache.org/dev/gitpubsub.html > > [4] https://github.com/apache/kudu/tree/gh-pages > > [5] https://github.com/apache/kudu/blob/gh-pages/site_tool > > [6] https://git-wip-us.apache.org/repos/asf?p=kudu-site.git;a= > > shortlog;h=refs/heads/asf-site > > [7] https://svn.apache.org/repos/asf/flume/site/trunk/ > > [8] https://svn.apache.org/repos/infra/websites/production/flume/ > > [9] https://www.apache.org/dev/cms.html > > [10] > > https://cwiki.apache.org/confluence/display/FLUME/How+ > to+Release#HowtoRelease-Updatethewebsite > > > > On Thu, Oct 20, 2016 at 2:59 PM, Balazs Donat Bessenyei < > bes...@cloudera.com > >> wrote: > > > >> As nobody has objected in ~48 hours, I'll open a pull request about this > >> soon. > >> > >> Regarding the whole site thing: AFAIK, the site contents have to > >> reside in SVN, because that's how ASF infrastructure works now. > >> > >> First, I'll work on moving the Developer Section to > >> https://github.com/apache/flume , then we'll see what else we can do. > >> > >> > >> Thank you, > >> > >> Donat > >> > >> On Thu, Oct 20, 2016 at 12:41 PM, UMESH CHAUDHARY <umesh9...@gmail.com> > >> wrote: > >> > +1 for moving wiki and web contents into GitHub. It would be easier to > >> > manage. Also, +1 for improving our website. > >> > > >> > On Thu, 20 Oct 2016 at 15:42 Lior Zeno <liorz...@gmail.com> wrote: > >> > > >> > +1 for moving the whole site as well. I wish we could improve our > >> frontend > >> > to become a bit more appealing. > >> > > >> > On Thu, Oct 20, 2016 at 11:53 AM, Attila Simon <s...@cloudera.com> > >> wrote: > >> > > >> >> +1 > >> >> Essentially moving whole site (all web content) to scm would help > >> >> contribution. > >> >> > >> >> Cheers, > >> >> Attila > >> >> > >> >> On Tuesday, 18 October 2016, Balazs Donat Bessenyei < > >> bes...@cloudera.com> > >> >> wrote: > >> >> > >> >> > Hi All, > >> >> > > >> >> > As it's kind of difficult to get permissions in the wiki to edit > pages > >> >> > like https://cwiki.apache.org/confluence/display/FLUME/How+to+ > >> Contribute > >> >> > , I suggest moving contents to the git repository into files like > >> >> > CONTRIBUTING.md, etc. > >> >> > > >> >> > I'd be happy to create the files and move the current texts. > >> >> > > >> >> > Please, let me know your thoughts. > >> >> > > >> >> > > >> >> > Thank you, > >> >> > > >> >> > Donat > >> >> > > >> >> > >> >> > >> >> -- > >> >> > >> >> *Attila Simon* > >> >> Software Engineer > >> >> Email: s...@cloudera.com > >> >> > >> >> [image: Cloudera Inc.] > >> >> > >> >
