... the process is quite simple: anything we push to the Github repo
"https://github.com/apache/fineract-site"; in branch "asf-site" will be
picked up automatically (I believe) by Apache Infrastructure (probably
via a simple Git pull) to publish them on the Apache domain (in our case
fineract.apache.org).
The documentation in HTML format under the "current" folder is generated
from the AsciiDoc (kind of a Markdown on steroids format) files.
Publishing again is a simple copy to the fineract-site repo and pushing
the udates to Github.
At the moment I do this manually (last update was a while ago). As part
of our release process we ship the current documentation in PDF (another
output format of AsciiDoc) with the downloadable release artifacts
(tar.gz files).
Note: there another set of HTML pages about the Fineract database
schema, tables, columns, relationships that are generated by another
command line tool (SchemaCrawler). I think I generated these pages only
a handful of times; at the moment not automated... and no feedback if
people find this useful or not. It would be great if they could generate
AsciiDoc instead of HTML only... then we could include this also in the
PDF documentation; but for now it is what it is.
Having said that: I think it would be great to have a static site
generator to manage all pages of the Fineract site. Apache Camel is - I
think - doing a great job managing their web site. It's a combination of
automatically generated pages for the documentation (also based on
AsciiDoc), they even give you access to all long term support versions
of the documentation plus the most recent one that is continually
updated from Github. Addtionally they have a landing page, a section
with blog entries and various other pages. Most of it is based on
AsciiDoc... they use then Antora (read: static site generator for
AsciiDoc... more about its capabilities here https://antora.org/) to
aggregate all of this into one coherent site. What I find really great
about this approach: every page has a Git reference; on pretty much
every page you can see a link "Edit this page"... in that way it's
almost like a Wiki or a CMS, just without the whole overhead and only
based on Git. Rebuild and publish of the site are very easy to configure
e. g. with Github actions. And of course the visual style of Antora's
output can be tweaked (https://docs.antora.org/antora-ui-default/).
Cheers
On 16/06/2023 22:00, James Dailey wrote:
Oh, I think you mean the documentation ==>
https://fineract.apache.org/docs/current/
That is generated at release time.
https://github.com/apache/fineract/tree/develop/fineract-doc
it uses the Asciidoctor plugin I believe.
@Aleksandar Vidakovic <mailto:chee...@monkeysintown.com> could you
explain the process please, I do not recall.
Where should we be updating the documentation? i.e. let's say we
want to add "how to build"
james
On Fri, Jun 16, 2023 at 12:43 PM James Dailey <jamespdai...@gmail.com>
wrote:
repo:apache/fineract-site
serves up as https://fineract.apache.org
so, it's just a simple javascript index.html
why?
Related: Please see email threads on wiki and website improvements.
https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
<https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
and
https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <chtom...@gmail.com>
wrote:
Cool. this all looks good. will chip away at working my way
through it. Curious, how is fineract.apache.org
<http://fineract.apache.org> served?
-Rob
