Hi Clay, response below On Fri, Oct 7, 2016 at 12:31 PM, < [email protected]> wrote:
> > From: "Gimenez, Clayton C." <[email protected]> > To: "[email protected]" <[email protected] > > > Cc: > Date: Wed, 05 Oct 2016 19:31:51 +0000 > Subject: SensSoft Website + Documentation > Hi all, > > Goal of this is to kick off a discussion of how we want to build > SensSoft’s main website and documentation pages, what they should include, > and what our Infra needs would be to support that. > [snip] > ... > Personally, I think I favor option #2. Each component can use > documentation styles and tools appropriate to its language/domain (esp. > with respect to inline documentation). As long as they compile to a > consistent format and folder structure, the website build system can parse > and include them in a unified experience. > > As far as Infra is concerned, Jekyll + Option 2 would only require static > web hosting. All the complex stuff would be preprocessing on the website > developer’s machine. In theory, it could be automated with something like > Jenkins to make the site autoupdate on component documentation change. > > Thoughts? > #2 sounds dynamite. I like the Jenkins idea and have never done it this way so it would be cool to get it working. i just wonder about how authentication is going to work. We can cross this bridge if we file an issue at INFRA. > > Thanks, > Clay > > > P.S. @Lewis: One question for you specifically — reviewing > http://incubator.apache.org/guides/sites.html and some Apache project > repos, it looks like the project’s website source is typically kept in the > project’s main repo. We don’t really have one of those. Do you know of > any prior projects with a similar issue? Yes loads of projects. Website source can easily be kept outside of the source code for the project(s) that is not an issue. > Do you think it makes sense to spin up a new repo, say > incubator-senssoft.git, for top-level project concerns like the website, > full system deployment tools, etc.? Yes I think it does. If you can log a ticket in INFRA Jira and tag me then I will help get this set up and also work with you on consolidating the Websiet documentation. Thanks for this, i am buzzing to see the Website up and running. You guys have some really neat looking documentation. Lewis
