Typically, Apache projects will use wiki for developer documentation, but the websites tend to be more user facing (with developer aspects).
John On Mon, Nov 6, 2017 at 1:38 PM Dave Fisher <[email protected]> wrote: > Hi - > > Make sure to study these two links. Pay attention to branding policy and > required ASF links > > https://www.apache.org/foundation/marks/pmcs > https://www.apache.org/dev/project-site.html > > Regards, > Dave > > > On Nov 6, 2017, at 10:34 AM, Steve Lawrence <[email protected]> > wrote: > > > > A website is a lot more customizable so we can do things that are a > > little more visually appealing than in the wiki, which is pretty plain > > and barebones. I think helps to make the project more mature and > > reputable. And it doesn't add much extra work. After only day or so of > > playing with it, there isn't much more work needed to get things up and > > running. > > > > It also has a nice templating feature, so you can update the template of > > multiple pages at once. So there's reduced effort for that. > > > > Another thing that's nice is the entire website would be stored in a git > > repo, so you can support everything that git support (e.g. pull > > requests, branch, reviews, etc.) so the contributor workflow exactly the > > same. > > > > This also doesn't mean we can't have anything point to the wiki. I'm > > sure we'll still use the wiki for things like architecture descriptions > > and things. But for stuff like downloading, high level description of > > daffodil, marketing kind of stuff, a website would be beneficial. > > > > > > On 11/06/2017 12:12 PM, Mike Beckerle wrote: > >> Why wouldn't we just put an automatic redirect to a home landing page > on the wiki? > >> > >> ________________________________ > >> From: Steve Lawrence <[email protected]> > >> Sent: Friday, November 3, 2017 10:49:08 AM > >> To: [email protected] > >> Subject: Daffodil Website > >> > >> I think our infrastructure move is nearing completion. I think there are > >> two remaining issues: > >> > >> 1) Wiki migration, which I think we should slowly and methodically move > >> over to force a much needed cleanup and reorganization. > >> > >> 2) Website. ASF provides hosting for a website at > >> http://daffodil.incubator.apache.org, but we must generate the content. > >> From the looks of other incubators, this doesn't need to be anything > >> super complicated, it more acts as a landing page for the project and > >> provides project information (e.g. github, how to contribute, > >> documentation, Apache info etc.). > >> > >> The website must be static (so no CGI/PHP/Python/etc.). Looking at other > >> incubators, it looks like there are a handful of static website > >> generators. The most popular looks to be built by Jekyll. A template for > >> Apache incubators was created that uses Jekyll here: > >> > >> https://github.com/apache/apache-website-template > >> > >> It's a little old, but I've played with it a bit and it seems more than > >> sufficient. The way it works (like I think many static website > >> generators) is that templates are created and then you just create > >> Markdown files that add content to the template. So making updates to > >> content is pretty simple. > >> > >> Some current incubators that use the above template or something very > >> similar: > >> > >> https://livy.incubator.apache.org/ > >> https://gossip.incubator.apache.org/ > >> https://rya.incubator.apache.org/ > >> https://toree.incubator.apache.org/ > >> https://guacamole.incubator.apache.org/ > >> https://s2graph.incubator.apache.org/download.html > >> https://s2graph.incubator.apache.org/ > >> > >> So it seems pretty popular and flexible. > >> > >> Unless anyone has any experience or suggestions for other static code > >> generators, I think it would be a good idea to start with that website > >> template and tweak it to meet our needs so we can get a good landing > >> page create for Daffodil. > >> > >> - Steve > >> > > > >
