I will start taking a look at these this week. On Sun, Dec 2, 2018 at 4:07 AM David Blevins <david.blev...@gmail.com> wrote:
> > On Dec 1, 2018, at 5:41 PM, David Blevins <david.blev...@gmail.com> > wrote: > > > > I'm attempting to get this to a point where we can crowd source some > non-automatable tasks. > [...] > > To get there I just need to 1) minimally improve the index pages to have > groups and 2) add the jbake headers to all the files > > Ok, indexing is in and JBake headers added. > > - http://tomee.apache.org/tomee-8.0/docs/ > - http://tomee.apache.org/tomee-8.0/examples/ > > Those preliminary groups are not anything near polished. Consider them > inspiration, but restriction. Feel free dramatically change the groups. > My intent is to do enough to show what can be done so others can be > productive. > > > What I'm imaging we can all do in a divide and conquer fashion: > > > > - Categorize each document for an intelligent looking index > > - Review each document for formatting issues > > - Convert markdown documents to asciidoc > > - Fix inconsistent h1, h2, h3 etc usage > > - Update branding to "TomEE" from "OpenEJB" > > - Ensure each has a title > > - Check links > > Open season on docs. Let the PRs fly! What we need is people to dig in > here and here: > > - https://github.com/apache/tomee/tree/master/docs > - https://github.com/apache/tomee/tree/master/examples > > And create PRs like these commits: > > - > https://github.com/apache/tomee/commit/bdee81d34c60644b755621254a535d0d8757eb21 > - > https://github.com/apache/tomee/commit/e2190a47c211c870680d761efd6d025d935546c7 > > While you're in there, make sure the document has a "title=Foo" > > I cannot stress enough the groupings you see do not reflect human action, > so do not get fussed with questions like "Why didn't he group this one as > CDI, it's clearly CDI???" I took an old index that was a bout 5 years > stale and used it to seed the groups like so: > > - > https://github.com/apache/tomee-site-generator/blob/master/src/main/java/org/apache/tomee/website/AddGroups.java > > So what you see a machine could do and did. We need humans to put some > thought into the best way to organize and put groups in that make sense. > > If you'd like to build the docs locally, run this long command and then > open your browser to http://localhost:8080 > > - git clone g...@github.com:apache/tomee-site-generator.git && cd > tomee-site-generator && mvn clean compile -Djbake.http=true > > That will clone the site repo and build it, which will in turn pull down > all the related TomEE branches. > > > -David > > -- Karan Singh Malhi
