Guten Tag Robert Middleton,
am Samstag, 19. September 2020 um 02:56 schrieben Sie:

> 1. Continue to utilize maven.  This has the advantage of making the site
> consistent with the other log4___ sites.  The disadvantage is that it
> is(currently) weird to update the site and has issues with releases.

Another advantage is that Maven generates some parts automatically,
like the overview for the lists, changes etc. One doesn't need to
maintain that manually too much, which would be the case when
switching.

In any case one needs to have a look at the additional logic
implemented by MVN/ANT to decide if that is needed for the new site as
well. Some of that logic deals with SVN-specifics, but some is related
to updating versions numbers and stuff like that when I remember
correctly. So content-based changes would need some replacement.

> 2. Move the entire site to doxygen.  This would mean that both the main
> site and the API documentation would be generated at the same time(which
> would be convenient), but is generally a lot uglier than the maven site.

Markdown supported by Doxygen seems a bit limited as well, but in any
case using Markdown for new content seems to make sense. We might not
care too much how that is rendered, maybe starting with Doxygen and
then moving on as needed?

> 3. Put the documentation in the log4cxx-site repo and utilize jekyll for
> the site(see:
> https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features#git.asf.yamlfeatures-JekyllCMS)
> This has the advantage of allowing custom skins(like the read-the-docs
> theme:https://github.com/rundocs/jekyll-rtd-theme), but it means that the
> API documentation would still have to be updated manually and comitted
> separately, and that the site content would live in a separate
> repository(as far as I can tell the site can't use a subdirectory from the
> main repository).

You have worked on GitHub-actions, isn't that something which could be
used to update the API-docs automatically somehow? Those are pretty
different from the site anyway, the content of the latter is to be
maintained manually, while API-docs are designed to be generated
automatically on each commit in theory.

Mit freundlichen Grüßen,

Thorsten Schöning

-- 
Thorsten Schöning       E-Mail: thorsten.schoen...@am-soft.de
AM-SoFT IT-Systeme      http://www.AM-SoFT.de/

Telefon...........05151-  9468- 55
Fax...............05151-  9468- 88
Mobil..............0178-8 9468- 04

AM-SoFT GmbH IT-Systeme, Brandenburger Str. 7c, 31789 Hameln
AG Hannover HRB 207 694 - Geschäftsführer: Andreas Muchow

Reply via email to