Moving Lucene web site to git and .asf.yaml

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Moving Lucene web site to git and .asf.yaml

Jan Høydahl / Cominvent
Hi all,

INFRA announced a few weeks back a new self-serve mechanism .asf.yaml:

    https://s.apache.org/asfyaml

As I understand it, the old forrest CMS built from svn will eventually go away
and this is the new shiny way to publish (and stage) project websites.

I propose that we start to play with .asf.yaml by first adding the file to change
our GitHub project description which now says "Mirror of Apache Lucene + Solr" :)

Next let's migrate our web site from the svn over to a new branch in our git repo.
We could choose to use the Pelican static site generator, and then stage/publish
the site automatically using .asf.yaml magic. Moving from forrest to Pelican
(https://blog.getpelican.com) will take some effort, but they are both based on
markdown and templating so should not be an impossible task :)

A positive site effect of moving our site to git could be that it gets easier to
dump our JavaDocs, RefGuide, future developer-Guides by simply committing html
files to the site git branch.

We should also design a new Lucene landing page but that's for another day...

--
Jan Høydahl, search solution architect
Cominvent AS - www.cominvent.com


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: Moving Lucene web site to git and .asf.yaml

Cassandra Targett
Sort of playing devil’s advocate for sake of discussion, why would we pick Pelican static site generator over Jekyll static site generator which we already use for the Ref Guide? Why would we stay with Markdown when we already know that Asciidoc is a much more expressive markup language that we already use for hundreds of pages of content?

I know nothing about Pelican - your mail is the first I heard of it - so asking that really just as a way to get more info for why you prefer it.

Assuming we move to a world where something like the Ref Guide is simply “website content”, I could see it becoming burdensome to generate HTML files with 2 different systems in 2 different formats, etc. Is that a valid concern or not something you’re worried about?

Cassandra
On Sep 19, 2019, 3:33 AM -0500, Jan Høydahl <[hidden email]>, wrote:
Hi all,

INFRA announced a few weeks back a new self-serve mechanism .asf.yaml:

https://s.apache.org/asfyaml

As I understand it, the old forrest CMS built from svn will eventually go away
and this is the new shiny way to publish (and stage) project websites.

I propose that we start to play with .asf.yaml by first adding the file to change
our GitHub project description which now says "Mirror of Apache Lucene + Solr" :)

Next let's migrate our web site from the svn over to a new branch in our git repo.
We could choose to use the Pelican static site generator, and then stage/publish
the site automatically using .asf.yaml magic. Moving from forrest to Pelican
(https://blog.getpelican.com) will take some effort, but they are both based on
markdown and templating so should not be an impossible task :)

A positive site effect of moving our site to git could be that it gets easier to
dump our JavaDocs, RefGuide, future developer-Guides by simply committing html
files to the site git branch.

We should also design a new Lucene landing page but that's for another day...

--
Jan Høydahl, search solution architect
Cominvent AS - www.cominvent.com


---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: Moving Lucene web site to git and .asf.yaml

Jan Høydahl / Cominvent
I just wanted to kickstart the discussion and let you know what exists, and INFRA just happens to support Pelican ootb.
Pelican also supports asciidoc through a plugin plugin https://github.com/getpelican/pelican-plugins/tree/master/asciidoc_reader, but our current web site is already in MD and I suppose it would be much quicker to just convert the pages into Pelican template syntax as is to complete the move to git, and then we could iterate from there. Jekyll would work too, but we'd need to provide the tooling and build infrastructure as well as rewrite all pages from md to asciidoc which suddenly becomes a quite much bigger project..

--
Jan Høydahl, search solution architect
Cominvent AS - www.cominvent.com

19. sep. 2019 kl. 15:39 skrev Cassandra Targett <[hidden email]>:

Sort of playing devil’s advocate for sake of discussion, why would we pick Pelican static site generator over Jekyll static site generator which we already use for the Ref Guide? Why would we stay with Markdown when we already know that Asciidoc is a much more expressive markup language that we already use for hundreds of pages of content?

I know nothing about Pelican - your mail is the first I heard of it - so asking that really just as a way to get more info for why you prefer it.

Assuming we move to a world where something like the Ref Guide is simply “website content”, I could see it becoming burdensome to generate HTML files with 2 different systems in 2 different formats, etc. Is that a valid concern or not something you’re worried about?

Cassandra
On Sep 19, 2019, 3:33 AM -0500, Jan Høydahl <[hidden email]>, wrote:
Hi all,

INFRA announced a few weeks back a new self-serve mechanism .asf.yaml:

https://s.apache.org/asfyaml

As I understand it, the old forrest CMS built from svn will eventually go away
and this is the new shiny way to publish (and stage) project websites.

I propose that we start to play with .asf.yaml by first adding the file to change
our GitHub project description which now says "Mirror of Apache Lucene + Solr" :)

Next let's migrate our web site from the svn over to a new branch in our git repo.
We could choose to use the Pelican static site generator, and then stage/publish
the site automatically using .asf.yaml magic. Moving from forrest to Pelican
(https://blog.getpelican.com) will take some effort, but they are both based on
markdown and templating so should not be an impossible task :)

A positive site effect of moving our site to git could be that it gets easier to
dump our JavaDocs, RefGuide, future developer-Guides by simply committing html
files to the site git branch.

We should also design a new Lucene landing page but that's for another day...

--
Jan Høydahl, search solution architect
Cominvent AS - www.cominvent.com


---------------------------------------------------------------------
To unsubscribe, [hidden email]
For additional commands, [hidden email]