fineract-site

Apache Fineract website source repository for https://fineract.apache.org, a Hugo-generated static website.

Prerequisites

• Git
• Docker

Guide to this repository

• Sources are in site-src/ (OK to edit)
• Static assets (published as-is, OK to edit)
  • docs/ → /docs/
  • css/ → /css/
  • js/ → /js/
  • images/ → /images/
  • font/ → /font/
  • .htaccess → /.htaccess
  • doap_Fineract.rdf → /doap_Fineract.rdf
• Generated output is in .build/site (do not edit)

Issue tracker

Issues are in GitHub as of July 20, 2026. Older ones are in JIRA.

Local Build and Checks (Docker)

1. Build the site tool image:

docker build -t fineract-site .

2. Build site and run checks:

docker run --rm -u "$(id -u):$(id -g)" -v "$PWD:/src" -w /src/site-src fineract-site build

3. Serve locally with watch mode:

docker run --rm -it -u "$(id -u):$(id -g)" -v "$PWD:/src" -w /src/site-src -p 1313:1313 fineract-site serve

4. Optional: run checks only (without rebuilding):

docker run --rm -u "$(id -u):$(id -g)" -v "$PWD:/src" -w /src/site-src fineract-site check

Windows PowerShell equivalent (no UID/GID mapping):

docker build -t fineract-site .
docker run --rm -v "${PWD}:/src" -w /src/site-src fineract-site build
docker run --rm -it -p 1313:1313 -v "${PWD}:/src" -w /src/site-src fineract-site serve

Updating /docs/VERSION from a Fineract backend clone

docs/VERSION (e.g. docs/1.16.0-SNAPSHOT) holds the rendered Fineract API documentation built from the apache/fineract backend. To refresh it:

1. In your clone of apache/fineract, generate the docs:

   ./gradlew asciidoctor

   Make sure the clone’s working tree is clean (git status) – the commit hash is recorded so the copied doc can be traced back to the exact source commit.

   Install Graphviz (dot), plus vl2vg and vg2svg (npm install -g vega-cli vega-lite), first. Without them the build still succeeds but leaves diagrams out: PlantUML draws a “Cannot find Graphviz” error image in place of each of its diagrams. fineract-site docs refuses such a page, and fineract-site build fails on any already in docs/ (scripts/check_doc_diagrams.py). After installing Graphviz, delete fineract-doc/build before rebuilding, as generated diagrams are cached.

2. Run the docs command in the site tool image, mounting both repos:

   docker run --rm -u "$(id -u):$(id -g)" \
     -v "$PWD:/src" \
     -v /path/to/fineract:/fineract:ro \
     -w /src \
     fineract-site docs --version 1.16.0-SNAPSHOT

   The version can also be set via FINERACT_DOC_VERSION, and the backend mount path via FINERACT_REPO_DIR (default /fineract).

This copies fineract-doc/build/docs/html/en/index.html from the backend clone into docs/VERSION/index.html, then rewrites the Google Fonts and Font Awesome CDN links to point at the site’s local css/ stylesheets (per Apache project website requirements). Versions ending in -SNAPSHOT are overwritten; released versions are not, unless you pass --replace-release to republish one from the same release tag (e.g. to fix a broken build).

It also suggests a commit message. Use it like so:

git commit -F DOCS-LOG-MESSAGE

After updating docs, update .htaccess.

Verifying ASF project website compliance

Apache Whimsy periodically checks that the public homepage follows ASF conventions. Output of these checks is displayed here.

Contributor Guide

See CONTRIBUTING.md for CI/CD details and branch/PR workflow.