On 2020/02/21 18:24:08, Andy Seaborne <[email protected]> wrote:
> 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.
This is indeed my suggestion as well because sites most probably need to be
updated separate from
releases.
>
> 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
If we have the following configured in the gitwcsub.cfg (INFRA stuff)
/www/jena.apache.org: $gitbox/jena-site
This means that the 'asf-site' contains a 'content' folder with the actual site
content.
/www/jena.apache.org/content/documentation/javadoc:
$gitbox/jena-site:release-docs
This means that everything from the root of the release-docs branch will be
served on
jena.apache.org/documentation/javadoc
The release-docs branch will contain an exact copy of the following:
https://svn.apache.org/repos/infra/websites/production/jena/content/documentation/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/
>
Copying the release-docs to the asf-site branch is not even necessary. The
config above (the INFRA
part) defines that on the production machine content is being served from 2
branches. It _is_
possible to copy it to the asf-site branch and then serve everything from the
asf-site, but that is just
an additional step which I wouldn't do personally (we already have all the
documentation available
on the release-docs branch, no need to copy it over. Just let INFRA handle the
merging of the actual
content.
> It emails [email protected] -- no need to change that :-)
Let's keep 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
The staging domain is indeed gone. An alternative could be to use Netlify
(netlify has free plans for
OSS projects). Netlify will build pull requests and comment with a link to the
preview. Celix has this
enabled as well. See this pull request as example:
https://github.com/apache/celix-site/pull/7
(of course cgi scripts are not working but this is expected behavior)
But maybe with the new site build solution that INFRA is currently working on
the staging domain
will be re-introduced as well ;) This is something we probably will find out in
a couple of weeks.
>
> Andy
>
