Looks great (#1 especially), and rendering markdown is the right choice. Please keep in mind Apache's podling website guidelines: https://incubator.apache.org/guides/sites.html That page suggests several other potential pages, like license, committers, mailing lists, etc.
On Thu, Sep 24, 2015 at 11:36 AM, Jim Klucar <[email protected]> wrote: > No problem Ruth. I envisioned the documentation being links to the wiki. In > fact I'm not sure about all the links on the left. I just stole from the > other apache sites. If you want to suggest what kind of pages we need on > the site, I'm open to listening. > > On Thu, Sep 24, 2015 at 2:29 PM, Ruth Harris <[email protected]> wrote: > > > HI Jim, > > > > I like #1. It's nice and clean. > > Re: markdown -> html on a website. I want to do this. > > > > But for consistency sake, the Wiki content needs to be reviewed and then > I > > can merge, add, etc... markdown files. I don't want to maintain 2 sets of > > docs, so after the Wiki content is review and migration to > > markdown/gitpages, we'll need to end-of-life the wiki info. > > > > I have a basic understanding of how to structure markdown files so that > > they have some order/structure to them, but I'll probably need some help > > getting things rolling on the Doc side. > > > > --Ruth > > > > Ruth Harris > > Sr. Tech Writer, MapR > > > > On Thu, Sep 24, 2015 at 10:36 AM, Jim Klucar <[email protected]> wrote: > > > > > Hi everyone, > > > > > > I started in on mocking up the site. I got tired of the bootstrap > navbar > > on > > > top approach so I came up with a few mock ups. Don't worry about the > > colors > > > not being right or whatever details that are off. > > > > > > 1) http://imgur.com/Or5Fkbx > > > 2) http://imgur.com/2ok8T98 > > > 3) http://imgur.com/al0gGht > > > > > > More importantly, I plan on implementing it using Jekyll ( > > > https://jekyllrb.com/) This is how github pages is done. > > > https://pages.github.com/ > > > > > > Basically Jekyll parses markdown files and injects them into HTML > > templates > > > and generates a static site. The main advantage is it is really > > blog-aware > > > so we can create new release notices, blog entries, etc by writing a > > > standalone markdown file and recompiling the site. The other advantage > is > > > we can redesign the website later and all the content won't have to be > > > ported. Jekyll will just inject the markdown content into the new site > > > design. > > > > > > Let me know what you think. If there aren't any objections to Jekyll I > > can > > > get started and we can quibble about design later. > > > > > > Jim > > > > > > > > > > > -- > > Ruth Harris > > Sr. Technical Writer, MapR > > >
