Is the following description correct and complete?

1/ We have repo "jena-site"

I prefer the website to be separate from the code and not in the source-release so we are free to publish the site at anytime.

2/ We have a branch of the "jena-site:asf-site" that is the published webside

3/ There is a "jena-site:release-docs" branch for javadoc
Let's say this has /javadoc

4/ The site is built by a Jenkins job at ASF. The job is triggered manually.
e.g.
https://builds.apache.org/job/celix-site/

It is restricted to run on 'git-websites'

5/ It runs a shell script - see the one for Celix -

In essence the job does:

* pull master
* run Hugo to get the pages in /temp-??/output
* switch to 'asf-site'
* copy /temp-??/output to /content
    /content/ is the site root.
* <javadoc>
* commit
* push -u

Is there an example of a project that does javadoc?
Looks to me like at <javadoc>

   git co release-docs
   cp -r /javadoc /content/documentation/

It emails [email protected] -- no need to change that :-)

We need to modify the script because it does not handle separate javadoc.

6/ There is no "jena.staging.apache.org". It is replaced by people running "hugo" locally to get "/target/content" : "hugo server" puts it on http://localhost:1313

    Andy

[A]
https://www.apache.org/dev/project-site.html

On 19/02/2020 18:40, Roy Lenferink wrote:
(inline comments)

On 2020/02/19 17:04:56, Andy Seaborne <[email protected]> wrote:

Sorry, I haven't had time to investigate all the machinery but if the
javadoc is a different branch or repo, how does publish happen? And not
happen for changes during the development cycle?


Publishing right now happens by checking out the 'production' site and adding 
the javadocs to there.
Publishing in the git way would happen by adding the generated javadocs to a 
separate branch or
repository.

Right now jena.a.o is served using SVN (config here [1]). In these config files 
it is possible to specify
multiple lines and specify a subfolder as well. E.g. what beam is doing here 
[2].

The following could make sense for jena:
/www/jena.apache.org:               $gitbox/jena-site
/www/jena.apache.org/content/documentation/javadoc: 
$gitbox/jena-site:release-docs

This means:
- That the 'master' branch will contain the sources for the site
- That the 'asf-site' branch will contain the generated output for the site
- That the 'release-docs' branch will contain additional files which will be 
served at http://jena.apache.org/documentation/javadoc/


I know infra is working on a CMS replacement and/or guidelines.  Is this
it? Is it compatible? I thought they were going to have a buildbot2.


Infra currently offers pelican and jekyll as 'replacements' for the CMS. 
However, Infra is also testing
a new build approach were the project can more or less define how their site is 
build [3]. This could
be a script to e.g. retrieve and execute Hugo.

I already had a quick chat with Infra about how to implement support for Hugo 
(e.g. next to Jekyll
and Pelican) but we decided that the new build approach will probably be a 
better fit.


Good to hear the community is interested in this :)

TBC: I am interested - I can't speak for the community.

My bad. I made the quick assumption by taking 2 responses and calling that 'the 
community', which is
almost never the case, oops!



Let me know if any additional information is needed.

Roy

[1] 
https://github.com/apache/infrastructure-puppet/blob/5bd3b7cc8bd6d8f2698a6e0cac1f421dd960ddf0/modules/svnwcsub/files/svnwcsub.conf#L115
[2] 
https://github.com/apache/infrastructure-puppet/blob/5bd3b7cc8bd6d8f2698a6e0cac1f421dd960ddf0/modules/gitwcsub/files/config/gitwcsub.cfg#L49-L50
[3] 
https://lists.apache.org/thread.html/rf0d4fef9b65e1ef346bc71b66253f9e54f15e048be6d011751a24ae0%40%3Cdev.community.apache.org%3E

Reply via email to