Yeah. More information can be found here: https://github.com/apache/incubator-heron/blob/master/website/README.md
Heron's documentation was primarily built using the following components: Hugo --- Static site generator GulpJS --- Build tool for static assets Twitter Bootstrap --- Sass/CSS and JavaScript Documentation Setup Running the Heron documentation locally requires that you have the following installed: Make Node.js npm pip - install PyYAML>=3.12 Go (make sure that your GOPATH and GOROOT are set) On Fri, Mar 22, 2019 at 10:50 AM Josh Fischer <[email protected]> wrote: > I have some time free over the next week, I can look into fixing the > build.. However, I think we should figure out the repo situation first with > the submodule that is tied to the documentation. > > My responses are in *bold. * > > On Fri, Mar 22, 2019 at 12:26 PM Dave Fisher <[email protected]> > wrote: > > > Hi - > > > > Thanks for asking. This has been on my list to discuss with the Heron > > community. > > > > The website is seriously non-compliant. > > > > > On Mar 22, 2019, at 9:38 AM, Josh Fischer <[email protected]> wrote: > > > > > > Hey All, > > > > > > With the heavy lifting behind us on the Bazel upgrade, I think the next > > > task we should tackle is fixing the public docs. I have a few questions > > > about them. > > > > > > 1. Are they still to be served from GH pages? > > > > No. > > > > > 2. If not where do they need to live? > > > > It should be on Apache servers as heron.apache.org < > > http://heron.apache.org/> > > > > Many projects build through Jenkins. There are requirements for the site > > which are scanned. > > > > There is a page here (needs some updates) > > > > https://incubator.apache.org/guides/sites.html < > > https://incubator.apache.org/guides/sites.html> > > > > Some projects keep a separate GitHub repository for their website. > > > > * I would recommend that we move the docs out of this repo or at least > remove the submodule. Working within the submodule has been quite a > difficult task.* > > > > > There is a lot wrong with the current website. > > > > This page was put onto the Incubator website this week. (It’s been my > > “distraction” the last few weeks.) > > https://incubator.apache.org/clutch/heron.html#errata < > > https://incubator.apache.org/clutch/heron.html#errata> > > > > Check out that almost all ASF links, trademarks, disclaimer, and > > copyrights are not correct on a site scan that is periodically performed. > > > > https://whimsy.apache.org/pods/project/heron < > > https://whimsy.apache.org/pods/project/heron> > > > > > > > 3. If I remember correctly, some steps in the Makefile are currently > > > broken for building the static assets. Once those issues are > resolved > > is > > > there anything else we need to do to release new set of docs? > > > > Follow what I listed on 2. > > > > What technology is used to build assets currently? > > > > * It looks like is a mix of technologies.. The main one being Gulp. > For generating java docs Bazel is used to query targets. Generating python > docs pdoc is used. * > > > > > > 4. Does updating the docs require a vote? > > > > Not normally. The Podling can decide if you want to use RTC or CTR. Since > > everything is in version control I would lean to CTR! > > > > Regards, > > Dave > > > > > > > > > > - Josh > > > > >
