Hi Roy - looks good! Thanks for pushing this along.#
We had discussed this using Jekyll (because GH uses Jekyll) but I read
that installation on Windows is easier for Hugo (the speed issue does not
look like such an advantage for us) - and that that is helpful to get more
contributions. CMS and "improve this page" editing has had a reasonable
amount of use over the years but we do need to migrate away from CMS.
Was conversion quite smooth? Any discoveries?
What's the markdown like? I don't know of anything special except of course
tables.
Managing javadoc separately would be nice. Putting a lot of javadoc into
svn is a bit clunky.
Andy
On Sun, 16 Feb 2020 at 12:37, Roy Lenferink <[email protected]> wrote:
> Hi Claude,
>
> Thanks for your email and thoughts! I wasn't aware of Disqus and its
> privacy policy. After checking I
> think you are talking about the following page [1]? On that page the
> following 2 statements are
> present:
> - "To use Hugo’s Disqus template, you first need to set a single value in
> your site’s config.toml or
> config.yml"
> - "To add Disqus, include the following line in templates where you want
> your comments to appear"
>
> However, using Disqus is not something we are doing [2]. This can be
> verified by e.g. doing the
> following:
>
> Roy@BTO-ROY:~/workspace/asf/jena-site$ hugo
>
> | EN
> -------------------------+------
> Pages | 230
> Paginator pages | 0
> Non-page files | 0
> Static files | 136
> Processed images | 0
> Aliases | 0
> Sitemaps | 1
> Cleaned | 0
>
> Total in 465 ms
>
> Roy@BTO-ROY:~/workspace/asf/jena-site$ grep -ri disqus
>
> Hugo writes the following [3] and how to disable specific options in the
> config.toml file [4].
>
> I think this clarifies your doubts, can you confirm?
>
> An alternative would be using e.g. Jekyll which I did some tests with as
> well. Jekyll can be extended
> with a lot of different plugins, however Hugo is easier to setup (single
> static binary) and faster to
> generate the site compared to Jekyll [5] (no metrics from me personally).
>
> Roy
>
> [1] https://gohugo.io/templates/internal/#configure-disqus
> [2] https://github.com/rlenferink/jena-site/blob/master/config.toml
> [3] https://gohugo.io/about/hugo-and-gdpr/
> [4] https://gohugo.io/about/hugo-and-gdpr/#disable-all-services
> [5] https://forestry.io/blog/hugo-vs-jekyll-benchmark/
>
> On 2020/02/16 11:34:28, Claude Warren <[email protected]> wrote:
> > I think this can be the first step in making the entire site deployment
> > process more automated and keeps us moving forward with supported
> > technologies.
> >
> > However, I note that the Hugo documentation states: "Hugo ships with an
> > internal Disqus template". I am concerned that the Discus connection may
> > not meet with the Apache Foundation's approach to privacy and data
> > sharing. I know there are problems with surveys and polls hosted by 3rd
> > parties.
> >
> > So:
> > +1 for moving to site to git.
> > -1 for using Hugo unless it can be deployed without 3rd party data
> sharing
> > or unless there is approval from Apache legal.
> >
> > Claude
> >
> > On Sat, Feb 15, 2020 at 1:28 PM Roy Lenferink <[email protected]>
> wrote:
> >
> > > Hi Jena community,
> > >
> > > I noticed Jena is still serving its site from SVN with help of the
> Apache
> > > CMS. At the Apache Celix
> > > project we decided to move away from the CMS and move towards git for
> > > serving our website [1].
> > > This because the CMS was introduced in 2010 and is currently not
> accepting
> > > any new projects. With
> > > the move to Hugo we're sure that we still can update the site when the
> ASF
> > > CMS will be
> > > decommissioned.
> > >
> > > The master branch contains the actual website sources whereas the
> > > generated website is served
> > > from the asf-site branch. Hugo is being used as static website
> generator.
> > > Content is written in
> > > Markdown.
> > >
> > > I had a look at Jena its site and it was quite easy to migrate Jena its
> > > site to use Hugo as well. An
> > > example of Hugo its output is (for demo purposes only) available on
> [2].
> > > These are the existing
> > > markdown files with a slightly changed header.
> > >
> > > Moving to git can enlarge the visibility of how projects are
> functioning.
> > > Next to that, new contributors
> > > can simply create a pull request against the website repository if they
> > > find anything they want to
> > > improve. I've updated the 'Improve this page' to 'Edit this page' which
> > > will open the GitHub webpage
> > > to edit the currently viewed page (currently returning a 404 because
> the
> > > apache/jena-site repository
> > > does not exist).
> > >
> > > If the community is interested in this move what I propose:
> > > - Someone from the PMC to request a new git repository for the website
> > > (e.g. jena-site) via [4]
> > > - Me creating the pull request from the repository I am temporarily
> using
> > > for the website contents [5]
> > > to the official jena-site repository
> > > - Create a Jenkins job to automatically build the site after changes
> > > happen on the master branch.
> > > - When the pull request is reviewed and merged ask INFRA to move over
> from
> > > the current svnpubsub
> > > to the gitpubsub approach and remove Jena from the Apache CMS.
> > >
> > > Next to that Jena is also providing javadocs on its site. My proposal
> for
> > > this is to serve them from a
> > > separate branch (e.g. release-docs). This way people who only want to
> > > clone the site can clone the
> > > the master branch using --single-branch and will not be bothered with
> > > cloning all the javadocs.
> > >
> > > All the URLs are still the same so the SEO score is not influenced in
> any
> > > way.
> > >
> > > I'd like to hear everyone's opinion on this :)
> > >
> > > Best regards,
> > > Roy
> > >
> > > [1] https://github.com/apache/celix-site
> > > [2] http://jena.roylenferink.nl/
> > > [3] http://celix.apache.org/contributing/releasing.html
> > > [4] https://gitbox.apache.org/setup/newrepo.html
> > > [5] https://github.com/rlenferink/jena-site
> > >
> >
> >
> > --
> > I like: Like Like - The likeliest place on the web
> > <http://like-like.xenei.com>
> > LinkedIn: http://www.linkedin.com/in/claudewarren
> >
>