meonkeys commented on code in PR #53: URL: https://github.com/apache/fineract-site/pull/53#discussion_r2842651792
########## .github/workflows/site-publish.yml: ########## @@ -0,0 +1,58 @@ +name: Site Publish + +on: + push: + branches: + - asf-site + workflow_dispatch: + +permissions: + contents: write + +concurrency: + group: site-publish + cancel-in-progress: false + +jobs: + publish: + # Prevent publish loops from bot commits and restrict to upstream repo. + if: github.repository == 'apache/fineract-site' && github.actor != 'github-actions[bot]' && (github.event_name != 'push' || !contains(github.event.head_commit.message, '[skip-publish]')) + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build site with pinned Hugo container + run: bash ./scripts/site-build.sh --cleanDestinationDir + + - name: Check internal links + run: python3 ./scripts/check_internal_links.py --site-root .build/site + + - name: Sync generated output into repository root + run: | + rsync -a --delete \ + --exclude '.git/' \ + --exclude '.github/' \ + --exclude 'site-src/' \ + --exclude 'scripts/' \ + --exclude '.build/' \ + --exclude '.asf.yaml' \ + --exclude '.gitignore' \ + --exclude 'README.md' \ + --exclude 'CONTRIBUTING.md' \ + --exclude 'LICENSE.txt' \ + .build/site/ ./ Review Comment: I ran this locally and `.htmlhintrc` was deleted. I guess that should be excluded too? ########## README.md: ########## @@ -1,21 +1,43 @@ # fineract-site -This is the Apache Fineract Website served on https://fineract.apache.org - -See [CONTRIBUTING.md](CONTRIBUTING.md) for local run/test instructions before opening a PR. - -## wish list - -- [ ] clean up unused code/static assets (fonts, icons, images, etc) -- [ ] use a static site generator, don't hand-code HTML - - [ ] validate links, markup, css, etc. -- [ ] auto-deploy website with every PR using an ASF tool or GitHub actions (commits to the asf-site branch do currently trigger auto-deploys, but this isn't set up for PRs) -- [ ] automate deployment of generated versioned asciidoc (don't commit it to apache/fineract-site repo – this creates a 2nd source of truth) -- [ ] fix text overlap with intermediate-sized media query -- [ ] document how to test locally, before/while committing -- [ ] additional review/critique of work done in https://github.com/apache/fineract-site/pull/37 -- [x] improve [a11y](https://www.accessibilitychecker.org/audit/?website=https%3A%2F%2Ffineract.apache.org&flag=us) (accessibility) - current score of 57 out of 100, with 30 critical issues (as of 2026-02-11, only one issue remains) -- [x] fix [missing fonts and icons](https://github.com/apache/fineract-site/pull/38#issuecomment-2916819388) -- [x] [Cache google assets](https://github.com/apache/fineract-site/pull/37) -- [x] https://github.com/apache/fineract-site/pull/37 -- [x] [migrate this wish list from Fineract JIRA](https://issues.apache.org/jira/browse/FINERACT-2192) +Apache Fineract website source repository for https://fineract.apache.org. + +## Source Of Truth + +- Hugo source is in `site-src/`. +- Generated output is in `.build/site`. +- Static passthrough is mounted from: + - `docs/` -> `/docs/` + - `css/` -> `/css/` + - `js/` -> `/js/` + - `images/` -> `/images/` + - `font/` -> `/font/` + - `.htaccess` -> `/.htaccess` + - `doap_Fineract.rdf` -> `/doap_Fineract.rdf` + +Do not edit generated output directly. Edit files under `site-src/` and mounted static sources instead. + +## Local Commands + +- PowerShell build: `./scripts/site-build.ps1 --cleanDestinationDir` +- Bash build: `./scripts/site-build.sh --cleanDestinationDir` +- PowerShell serve: `./scripts/site-serve.ps1` +- Bash serve: `./scripts/site-serve.sh` +- Internal link check: `python ./scripts/check_internal_links.py --site-root .build/site` + +Default Hugo image is `hugomods/hugo:debian-reg-dart-sass-0.156.0`. Override with `HUGO_IMAGE`. Review Comment: Is overriding important? I'd say get rid of `HUGO_IMAGE` and hard code the image name instead. I think we won't want people building with different versions of Hugo. ########## site-src/data/home.yml: ########## @@ -0,0 +1,377 @@ +lang: "en" +title: "Apache Fineract®" +favicon: "images/apache-fineract-icon.png" + +meta: + charset: "UTF-8" + viewport: "width=device-width, initial-scale=1.0" + +body: + id: "top" + class: "ghost-white jet-text" + +styles: + - href: "css/material-icons.css" + type: "text/css" + - href: "css/materialize.min.css" + type: "text/css" + - href: "css/nav-styles.css" + type: "text/css" + - href: "css/fineract.css" + type: "text/css" + +nav: + links: + - label: "About" + href: "#about" + icon: "info" + - label: "Contribute" + href: "#contribute" + icon: "people" + - label: "Downloads" + href: "#downloads" + icon: "download" + - label: "Resources" + href: "#resources" + icon: "library_books" + - label: "Reference" + href: "#reference" + icon: "link" + +homepage: + page_heading: "Apache Fineract®" + platform: + title: "Platform for Digital Financial Services" + intro: + icon: "account_balance" + title: "What is Apache Fineract®?" + text: "Apache Fineract® (\\'fīn-,ә-,rakt\\) is open source software for financial services, designed to create a cloud-ready core banking system that enables digital financial services for everyone, including the unbanked and underbanked." + mission: + icon: "rocket_launch" + title: "Our Mission" + items: + - icon: "cloud_done" + text: "Build and maintain a cloud-ready core banking system" + - icon: "security" + text: "Ensure robust, scalable, and secure operations" + - icon: "accessibility_new" + text: "Promote financial inclusion worldwide" + - icon: "savings" + text: "Enable digital transaction accounts for all" + benefits: + icon: "stars" + title: "Key Benefits" + items: + - icon: "verified" + title: "Reliable" + text: "Proven track record in high-transaction environments" + - icon: "trending_up" + title: "Scalable" + text: "Designed for cloud deployment and growth" + - icon: "savings" + title: "Affordable" + text: "Cost-effective solution for institutions of all sizes" + - icon: "api" + title: "Open APIs" + text: "Headless application design for maximum flexibility" + solution_providers: + title: "For Solution Providers" + intro: "Fineract® 1.x is a cloud-ready platform with open APIs, designed as a headless application.<br>This makes it ideal for solution providers who want to:" + cards: + - icon: "integration_instructions" + title: "Integrate" + text: "Build custom interfaces and extensions" + - icon: "architecture" + title: "Scale" + text: "Deploy cloud-native solutions" + - icon: "hub" + title: "Innovate" + text: "Create unique financial products" + + about: + id: "about" + title: "About - TEST" + intro: + icon: "info" + title: "What is Fineract®?" + text: "Apache Fineract® is a sophisticated core banking system that provides comprehensive financial technology solutions. It offers robust features for client data management, loan and savings portfolio management, integrated real-time accounting, and extensive reporting capabilities." + columns: + - icon: "settings" + title: "Key Features" + items: + - icon: "tune" + title: "Flexible Product Configuration" + text: "Customize financial products to meet your needs" + - icon: "verified_user" + title: "KYC Documentation Support" + text: "Flexible customer system of record" + - icon: "rule" + title: "Business Rule Sets" + text: "Four eyes principles and configurable workflows" + - icon: "payments" + title: "Payment Recognitions" + text: "System of record for repayments" + - icon: "account_balance" + title: "Portfolio Management" + text: "Complete loan and investment tracking" + - icon: "architecture" + title: "Deployment Options" + items: + - icon: "cloud" + title: "Cloud Deployment" + text: "Scalable cloud-based solutions with active community support" + - icon: "computer" + title: "On-Premise" + text: "Legacy or Traditional deployment" + - icon: "phone_iphone" + title: "Mobile Access via Headless Design" + text: "Headless designs allow for third party mobile solutions" + - icon: "api" + title: "Open API" + text: "Comprehensive API support since 2011" + - icon: "extension" + title: "Extensible Architecture" + text: "Support for any organizational type or delivery channel" + notices: + - panel_class: "yellow lighten-4" + icon: "warning" + title: "Important Notice" + intro: "We encourage all users of Fineract® to:" + items: + - "Consult competent technical resources for questions about secure deployment and operation" + - "Review the <a href=\"https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327\";>FAQ</a> and <a href=\"https://fineract.apache.org/docs/current/#_securing_fineract\";>Security Guide</a> for essential setup information" + - "Refer to the Apache license for legal information" + - panel_class: "red lighten-5" + icon: "history" + title: "Deprecated Sub-Project Notice" + text: "The Fineract® CN project (microservice architecture version) was deprecated in May 2023 and archived in late 2023. While this side-project served an important role in describing a microservice approach, it was never officially released." + + contribute: + id: "contribute" + title: "Contribute" + intro_card: + icon: "people" + title: "Join Our Community" + paragraphs: + - "The Apache Fineract® community <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>welcomes contributors</a> who want to support the Fineract® technology. Our community builds everything from <a href=\"https://github.com/apache/fineract-site\";>this website</a>, to the <a href=\"https://github.com/apache/fineract\";>Fineract® code</a> to <a href=\"https://github.com/apache/fineract/tree/develop/fineract-doc/src/docs/en/\";>documentation</a> and best practices information." + - "We especially welcome additions and corrections to the documentation, <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/\";>wiki</a>, and website to improve the user experience. Bug reports and fixes and additions to the Apache Fineract® code are welcome. Helping users learn best practices also earns good karma in our community." + - "Security vulnerabilities necessitate special handling: These must be reported privately and immediately to the Apache Fineract® Security Team, via email, to security at fineract.apache.org. Review and follow the <a href=\"https://www.apache.org/security/\"; target=\"_blank\" rel=\"noopener\">Apache Security Team vulnerability reporting guidelines</a>, especially with regard to <a href=\"https://www.apache.org/security/committers.html#possible\"; target=\"_blank\" rel=\"noopener\">working in private</a> prior to public disclosure." + ways: + icon: "build" + title: "Ways to Contribute" + items: + - icon: "code" + text: "Submit bug fixes and new features to the codebase" + - icon: "description" + text: "Improve documentation and wiki pages" + - icon: "web" + text: "Enhance the website user experience" + - icon: "school" + text: "Help users learn best practices" + - icon: "bug_report" + text: "Report bugs and suggest improvements" + mailing_lists: + icon: "mail" + title: "Mailing Lists" + subscribe_label: "Subscribe" + archives_label: "Archives" + entries: + - title: "Development List" + description: "For users, developers, and contributors discussing Apache Fineract®" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + - title: "Commits List" + description: "Receive notifications of all code contributions" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + - title: "Issues List" + description: "Receive notifications of all issue tracker activity" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + getting_started: + panel_class: "yellow lighten-4" + icon: "tips_and_updates" + title: "Getting Started" + intro: "New to contributing? Check out our <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>Contributor's Guide</a> for:" + columns: + - + - "Development environment setup" + - "Coding standards and best practices" + - "Pull request guidelines" + - + - "Testing procedures" + - "Documentation guidelines" + - "Community best practices" + + downloads: + id: "downloads" + title: "Downloads" + intro: "Below you'll find official Apache Fineract® releases. We recommend using the latest stable version. Each release includes binary and source distributions with corresponding verification files." + table: + headers: + - "Version" + - "Status" + - "Release Notes" + - "Binary" + - "Source" + rows: + - version: "1.14.0" + version_class: "green-text" Review Comment: I don't love mixing style (presentation) and data/content here. Maybe you can determine this from the `status` field instead? e.g. `current stable` is rendered green ########## site-src/content/security.md: ########## @@ -17,84 +23,84 @@ specific language governing permissions and limitations under the License. <!-- -⚠️ DO NOT EDIT security.html DIRECTLY, EDIT src/security/security.md INSTEAD ⚠️ +⚠️ DO NOT EDIT GENERATED OUTPUT DIRECTLY, EDIT site-src/content/security.md INSTEAD ⚠️ --> -This page lists all security vulnerabilities fixed in released versions of Apache Fineract. Each vulnerability is reported via [the ASF process](http://www.apache.org/security/) and given a security impact rating. +This page lists all security vulnerabilities fixed in released versions of Apache Fineract®. Each vulnerability is reported via [the ASF process](http://www.apache.org/security/) and given a security impact rating. -If you have identified a security issue, let us know immediately via email to security AT fineract.apache.org. And be sure to [secure your Fineract server](https://fineract.apache.org/docs/current/#_securing_fineract)! +If you have identified a security issue, let us know immediately via email to security AT fineract.apache.org. And be sure to [secure your Fineract® server](https://fineract.apache.org/docs/current/#_securing_fineract)! -## Fixed in Apache Fineract 1.12.1 +## Fixed in Apache Fineract® 1.12.1 {#fixed-in-apache-fineract-1.12.1} ### [CVE-2025-58137](https://www.cve.org/CVERecord?id=CVE-2025-58137): auth bypass through user-controlled key -Authorization Bypass Through User-Controlled Key vulnerability in Apache Fineract. +Authorization Bypass Through User-Controlled Key vulnerability in Apache Fineract®. Review Comment: Would it make more sense to move these data to YAML and just have a template with a loop instead? That might be better for maintenance. The format is, intentionally, very consistent: Title, description, reportDate, fixDate, affectsVersion, thanks, etc... ########## README.md: ########## @@ -1,21 +1,43 @@ # fineract-site -This is the Apache Fineract Website served on https://fineract.apache.org - -See [CONTRIBUTING.md](CONTRIBUTING.md) for local run/test instructions before opening a PR. - -## wish list - -- [ ] clean up unused code/static assets (fonts, icons, images, etc) -- [ ] use a static site generator, don't hand-code HTML - - [ ] validate links, markup, css, etc. -- [ ] auto-deploy website with every PR using an ASF tool or GitHub actions (commits to the asf-site branch do currently trigger auto-deploys, but this isn't set up for PRs) -- [ ] automate deployment of generated versioned asciidoc (don't commit it to apache/fineract-site repo – this creates a 2nd source of truth) -- [ ] fix text overlap with intermediate-sized media query -- [ ] document how to test locally, before/while committing -- [ ] additional review/critique of work done in https://github.com/apache/fineract-site/pull/37 -- [x] improve [a11y](https://www.accessibilitychecker.org/audit/?website=https%3A%2F%2Ffineract.apache.org&flag=us) (accessibility) - current score of 57 out of 100, with 30 critical issues (as of 2026-02-11, only one issue remains) -- [x] fix [missing fonts and icons](https://github.com/apache/fineract-site/pull/38#issuecomment-2916819388) -- [x] [Cache google assets](https://github.com/apache/fineract-site/pull/37) -- [x] https://github.com/apache/fineract-site/pull/37 -- [x] [migrate this wish list from Fineract JIRA](https://issues.apache.org/jira/browse/FINERACT-2192) +Apache Fineract website source repository for https://fineract.apache.org. + +## Source Of Truth + +- Hugo source is in `site-src/`. +- Generated output is in `.build/site`. +- Static passthrough is mounted from: + - `docs/` -> `/docs/` + - `css/` -> `/css/` + - `js/` -> `/js/` + - `images/` -> `/images/` + - `font/` -> `/font/` + - `.htaccess` -> `/.htaccess` + - `doap_Fineract.rdf` -> `/doap_Fineract.rdf` + +Do not edit generated output directly. Edit files under `site-src/` and mounted static sources instead. + +## Local Commands + +- PowerShell build: `./scripts/site-build.ps1 --cleanDestinationDir` +- Bash build: `./scripts/site-build.sh --cleanDestinationDir` +- PowerShell serve: `./scripts/site-serve.ps1` +- Bash serve: `./scripts/site-serve.sh` +- Internal link check: `python ./scripts/check_internal_links.py --site-root .build/site` Review Comment: I want to simplify things here. I don't want to maintain parallel PowerShell and Bash scripts/instructions. How about we hide the complexity with Docker? If we build and do checks in a container, then our instructions here are a few docker build/run commands and python is no longer a prereq. The prereqs become simply Git and Docker. I suggest we use something simple/popular like the upstream Ubuntu 24.04 base image, then install hugo, python 3, npm, htmlhint, and axe. Create an entrypoint script written in python or bash that accepts `build` or `serve`. `build` would do checks (or separate those into `check` if that is useful). The instructions in the readme would look something like this for a Bash-like shell: ```bash # create site builder/checker image docker build -t fineract-site . # lint, build, check docker run --rm -it -v "$PWD:/src" -w /src/site-src fineract-site build # serve website locally and watch for changes docker run --rm -it -v "$PWD:/src" -w /src/site-src fineract-site -p 1313:1313 serve ``` I'm fine with including how to run instructions for Windows and macOS, hopefully the differences are very minimal (e.g. maybe using something else instead of `$PWD`). Consider using this same image during the GitHub PR check workflow... that would be especially elegant! ########## .github/workflows/site-pr-check.yml: ########## @@ -0,0 +1,30 @@ +name: Site PR Check + +on: + pull_request: + branches: + - asf-site + workflow_dispatch: + +jobs: + build-and-validate: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Build site with pinned Hugo container + run: bash ./scripts/site-build.sh --cleanDestinationDir + + - name: Check internal links + run: python3 ./scripts/check_internal_links.py --site-root .build/site + + - name: HTML lint + run: | + npm install -g [email protected] + htmlhint ".build/site/**/*.html" --config .htmlhintrc || true + + - name: Accessibility check + run: | + npm install -g @axe-core/[email protected] + axe .build/site/index.html .build/site/security.html --exit || true Review Comment: Let's help users run these checks locally, too. This will make it easier for folks to create PRs. ########## site-src/data/home.yml: ########## @@ -0,0 +1,377 @@ +lang: "en" +title: "Apache Fineract®" +favicon: "images/apache-fineract-icon.png" + +meta: + charset: "UTF-8" + viewport: "width=device-width, initial-scale=1.0" + +body: + id: "top" + class: "ghost-white jet-text" + +styles: + - href: "css/material-icons.css" + type: "text/css" + - href: "css/materialize.min.css" + type: "text/css" + - href: "css/nav-styles.css" + type: "text/css" + - href: "css/fineract.css" + type: "text/css" + +nav: + links: + - label: "About" + href: "#about" + icon: "info" + - label: "Contribute" + href: "#contribute" + icon: "people" + - label: "Downloads" + href: "#downloads" + icon: "download" + - label: "Resources" + href: "#resources" + icon: "library_books" + - label: "Reference" + href: "#reference" + icon: "link" + +homepage: + page_heading: "Apache Fineract®" + platform: + title: "Platform for Digital Financial Services" + intro: + icon: "account_balance" + title: "What is Apache Fineract®?" + text: "Apache Fineract® (\\'fīn-,ә-,rakt\\) is open source software for financial services, designed to create a cloud-ready core banking system that enables digital financial services for everyone, including the unbanked and underbanked." + mission: + icon: "rocket_launch" + title: "Our Mission" + items: + - icon: "cloud_done" + text: "Build and maintain a cloud-ready core banking system" + - icon: "security" + text: "Ensure robust, scalable, and secure operations" + - icon: "accessibility_new" + text: "Promote financial inclusion worldwide" + - icon: "savings" + text: "Enable digital transaction accounts for all" + benefits: + icon: "stars" + title: "Key Benefits" + items: + - icon: "verified" + title: "Reliable" + text: "Proven track record in high-transaction environments" + - icon: "trending_up" + title: "Scalable" + text: "Designed for cloud deployment and growth" + - icon: "savings" + title: "Affordable" + text: "Cost-effective solution for institutions of all sizes" + - icon: "api" + title: "Open APIs" + text: "Headless application design for maximum flexibility" + solution_providers: + title: "For Solution Providers" + intro: "Fineract® 1.x is a cloud-ready platform with open APIs, designed as a headless application.<br>This makes it ideal for solution providers who want to:" + cards: + - icon: "integration_instructions" + title: "Integrate" + text: "Build custom interfaces and extensions" + - icon: "architecture" + title: "Scale" + text: "Deploy cloud-native solutions" + - icon: "hub" + title: "Innovate" + text: "Create unique financial products" + + about: + id: "about" + title: "About - TEST" + intro: + icon: "info" + title: "What is Fineract®?" + text: "Apache Fineract® is a sophisticated core banking system that provides comprehensive financial technology solutions. It offers robust features for client data management, loan and savings portfolio management, integrated real-time accounting, and extensive reporting capabilities." + columns: + - icon: "settings" + title: "Key Features" + items: + - icon: "tune" + title: "Flexible Product Configuration" + text: "Customize financial products to meet your needs" + - icon: "verified_user" + title: "KYC Documentation Support" + text: "Flexible customer system of record" + - icon: "rule" + title: "Business Rule Sets" + text: "Four eyes principles and configurable workflows" + - icon: "payments" + title: "Payment Recognitions" + text: "System of record for repayments" + - icon: "account_balance" + title: "Portfolio Management" + text: "Complete loan and investment tracking" + - icon: "architecture" + title: "Deployment Options" + items: + - icon: "cloud" + title: "Cloud Deployment" + text: "Scalable cloud-based solutions with active community support" + - icon: "computer" + title: "On-Premise" + text: "Legacy or Traditional deployment" + - icon: "phone_iphone" + title: "Mobile Access via Headless Design" + text: "Headless designs allow for third party mobile solutions" + - icon: "api" + title: "Open API" + text: "Comprehensive API support since 2011" + - icon: "extension" + title: "Extensible Architecture" + text: "Support for any organizational type or delivery channel" + notices: + - panel_class: "yellow lighten-4" + icon: "warning" + title: "Important Notice" + intro: "We encourage all users of Fineract® to:" + items: + - "Consult competent technical resources for questions about secure deployment and operation" + - "Review the <a href=\"https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327\";>FAQ</a> and <a href=\"https://fineract.apache.org/docs/current/#_securing_fineract\";>Security Guide</a> for essential setup information" + - "Refer to the Apache license for legal information" + - panel_class: "red lighten-5" + icon: "history" + title: "Deprecated Sub-Project Notice" + text: "The Fineract® CN project (microservice architecture version) was deprecated in May 2023 and archived in late 2023. While this side-project served an important role in describing a microservice approach, it was never officially released." + + contribute: + id: "contribute" + title: "Contribute" + intro_card: + icon: "people" + title: "Join Our Community" + paragraphs: + - "The Apache Fineract® community <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>welcomes contributors</a> who want to support the Fineract® technology. Our community builds everything from <a href=\"https://github.com/apache/fineract-site\";>this website</a>, to the <a href=\"https://github.com/apache/fineract\";>Fineract® code</a> to <a href=\"https://github.com/apache/fineract/tree/develop/fineract-doc/src/docs/en/\";>documentation</a> and best practices information." + - "We especially welcome additions and corrections to the documentation, <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/\";>wiki</a>, and website to improve the user experience. Bug reports and fixes and additions to the Apache Fineract® code are welcome. Helping users learn best practices also earns good karma in our community." + - "Security vulnerabilities necessitate special handling: These must be reported privately and immediately to the Apache Fineract® Security Team, via email, to security at fineract.apache.org. Review and follow the <a href=\"https://www.apache.org/security/\"; target=\"_blank\" rel=\"noopener\">Apache Security Team vulnerability reporting guidelines</a>, especially with regard to <a href=\"https://www.apache.org/security/committers.html#possible\"; target=\"_blank\" rel=\"noopener\">working in private</a> prior to public disclosure." + ways: + icon: "build" + title: "Ways to Contribute" + items: + - icon: "code" + text: "Submit bug fixes and new features to the codebase" + - icon: "description" + text: "Improve documentation and wiki pages" + - icon: "web" + text: "Enhance the website user experience" + - icon: "school" + text: "Help users learn best practices" + - icon: "bug_report" + text: "Report bugs and suggest improvements" + mailing_lists: + icon: "mail" + title: "Mailing Lists" + subscribe_label: "Subscribe" + archives_label: "Archives" + entries: + - title: "Development List" + description: "For users, developers, and contributors discussing Apache Fineract®" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + - title: "Commits List" + description: "Receive notifications of all code contributions" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + - title: "Issues List" + description: "Receive notifications of all issue tracker activity" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + getting_started: + panel_class: "yellow lighten-4" + icon: "tips_and_updates" + title: "Getting Started" + intro: "New to contributing? Check out our <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>Contributor's Guide</a> for:" + columns: + - + - "Development environment setup" + - "Coding standards and best practices" + - "Pull request guidelines" + - + - "Testing procedures" + - "Documentation guidelines" + - "Community best practices" + + downloads: + id: "downloads" + title: "Downloads" + intro: "Below you'll find official Apache Fineract® releases. We recommend using the latest stable version. Each release includes binary and source distributions with corresponding verification files." + table: + headers: + - "Version" + - "Status" + - "Release Notes" + - "Binary" + - "Source" + rows: + - version: "1.14.0" + version_class: "green-text" + status: "current stable" + release_notes: + href: "https://cwiki.apache.org/confluence/display/FINERACT/1.14.0+-+Apache+Fineract"; + label: "Apache Fineract® 1.14.0" + binary: + file: + href: "https://www.apache.org/dyn/closer.lua/fineract/1.14.0/apache-fineract-bin-1.14.0.tar.gz"; + label: "apache-fineract-bin-1.14.0.tar.gz" + checksums: + - label: "asc" Review Comment: this is more accurately a GPG signature file, not a checksum (although it probably also has a checksum, now that I think about it) ########## site-src/data/home.yml: ########## @@ -0,0 +1,377 @@ +lang: "en" +title: "Apache Fineract®" +favicon: "images/apache-fineract-icon.png" + +meta: + charset: "UTF-8" + viewport: "width=device-width, initial-scale=1.0" + +body: + id: "top" + class: "ghost-white jet-text" + +styles: + - href: "css/material-icons.css" + type: "text/css" + - href: "css/materialize.min.css" + type: "text/css" + - href: "css/nav-styles.css" + type: "text/css" + - href: "css/fineract.css" + type: "text/css" + +nav: + links: + - label: "About" + href: "#about" + icon: "info" + - label: "Contribute" + href: "#contribute" + icon: "people" + - label: "Downloads" + href: "#downloads" + icon: "download" + - label: "Resources" + href: "#resources" + icon: "library_books" + - label: "Reference" + href: "#reference" + icon: "link" + +homepage: + page_heading: "Apache Fineract®" + platform: + title: "Platform for Digital Financial Services" + intro: + icon: "account_balance" + title: "What is Apache Fineract®?" + text: "Apache Fineract® (\\'fīn-,ә-,rakt\\) is open source software for financial services, designed to create a cloud-ready core banking system that enables digital financial services for everyone, including the unbanked and underbanked." + mission: + icon: "rocket_launch" + title: "Our Mission" + items: + - icon: "cloud_done" + text: "Build and maintain a cloud-ready core banking system" + - icon: "security" + text: "Ensure robust, scalable, and secure operations" + - icon: "accessibility_new" + text: "Promote financial inclusion worldwide" + - icon: "savings" + text: "Enable digital transaction accounts for all" + benefits: + icon: "stars" + title: "Key Benefits" + items: + - icon: "verified" + title: "Reliable" + text: "Proven track record in high-transaction environments" + - icon: "trending_up" + title: "Scalable" + text: "Designed for cloud deployment and growth" + - icon: "savings" + title: "Affordable" + text: "Cost-effective solution for institutions of all sizes" + - icon: "api" + title: "Open APIs" + text: "Headless application design for maximum flexibility" + solution_providers: + title: "For Solution Providers" + intro: "Fineract® 1.x is a cloud-ready platform with open APIs, designed as a headless application.<br>This makes it ideal for solution providers who want to:" + cards: + - icon: "integration_instructions" + title: "Integrate" + text: "Build custom interfaces and extensions" + - icon: "architecture" + title: "Scale" + text: "Deploy cloud-native solutions" + - icon: "hub" + title: "Innovate" + text: "Create unique financial products" + + about: + id: "about" + title: "About - TEST" + intro: + icon: "info" + title: "What is Fineract®?" + text: "Apache Fineract® is a sophisticated core banking system that provides comprehensive financial technology solutions. It offers robust features for client data management, loan and savings portfolio management, integrated real-time accounting, and extensive reporting capabilities." + columns: + - icon: "settings" + title: "Key Features" + items: + - icon: "tune" + title: "Flexible Product Configuration" + text: "Customize financial products to meet your needs" + - icon: "verified_user" + title: "KYC Documentation Support" + text: "Flexible customer system of record" + - icon: "rule" + title: "Business Rule Sets" + text: "Four eyes principles and configurable workflows" + - icon: "payments" + title: "Payment Recognitions" + text: "System of record for repayments" + - icon: "account_balance" + title: "Portfolio Management" + text: "Complete loan and investment tracking" + - icon: "architecture" + title: "Deployment Options" + items: + - icon: "cloud" + title: "Cloud Deployment" + text: "Scalable cloud-based solutions with active community support" + - icon: "computer" + title: "On-Premise" + text: "Legacy or Traditional deployment" + - icon: "phone_iphone" + title: "Mobile Access via Headless Design" + text: "Headless designs allow for third party mobile solutions" + - icon: "api" + title: "Open API" + text: "Comprehensive API support since 2011" + - icon: "extension" + title: "Extensible Architecture" + text: "Support for any organizational type or delivery channel" + notices: + - panel_class: "yellow lighten-4" + icon: "warning" + title: "Important Notice" + intro: "We encourage all users of Fineract® to:" + items: + - "Consult competent technical resources for questions about secure deployment and operation" + - "Review the <a href=\"https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327\";>FAQ</a> and <a href=\"https://fineract.apache.org/docs/current/#_securing_fineract\";>Security Guide</a> for essential setup information" + - "Refer to the Apache license for legal information" + - panel_class: "red lighten-5" + icon: "history" + title: "Deprecated Sub-Project Notice" + text: "The Fineract® CN project (microservice architecture version) was deprecated in May 2023 and archived in late 2023. While this side-project served an important role in describing a microservice approach, it was never officially released." + + contribute: + id: "contribute" + title: "Contribute" + intro_card: + icon: "people" + title: "Join Our Community" + paragraphs: + - "The Apache Fineract® community <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>welcomes contributors</a> who want to support the Fineract® technology. Our community builds everything from <a href=\"https://github.com/apache/fineract-site\";>this website</a>, to the <a href=\"https://github.com/apache/fineract\";>Fineract® code</a> to <a href=\"https://github.com/apache/fineract/tree/develop/fineract-doc/src/docs/en/\";>documentation</a> and best practices information." + - "We especially welcome additions and corrections to the documentation, <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/\";>wiki</a>, and website to improve the user experience. Bug reports and fixes and additions to the Apache Fineract® code are welcome. Helping users learn best practices also earns good karma in our community." + - "Security vulnerabilities necessitate special handling: These must be reported privately and immediately to the Apache Fineract® Security Team, via email, to security at fineract.apache.org. Review and follow the <a href=\"https://www.apache.org/security/\"; target=\"_blank\" rel=\"noopener\">Apache Security Team vulnerability reporting guidelines</a>, especially with regard to <a href=\"https://www.apache.org/security/committers.html#possible\"; target=\"_blank\" rel=\"noopener\">working in private</a> prior to public disclosure." + ways: + icon: "build" + title: "Ways to Contribute" + items: + - icon: "code" + text: "Submit bug fixes and new features to the codebase" + - icon: "description" + text: "Improve documentation and wiki pages" + - icon: "web" + text: "Enhance the website user experience" + - icon: "school" + text: "Help users learn best practices" + - icon: "bug_report" + text: "Report bugs and suggest improvements" + mailing_lists: + icon: "mail" + title: "Mailing Lists" + subscribe_label: "Subscribe" + archives_label: "Archives" + entries: + - title: "Development List" + description: "For users, developers, and contributors discussing Apache Fineract®" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + - title: "Commits List" + description: "Receive notifications of all code contributions" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + - title: "Issues List" + description: "Receive notifications of all issue tracker activity" + email: "[email protected]" + subscribe: "mailto:[email protected]"; + archives: "https://lists.apache.org/[email protected]"; + getting_started: + panel_class: "yellow lighten-4" + icon: "tips_and_updates" + title: "Getting Started" + intro: "New to contributing? Check out our <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>Contributor's Guide</a> for:" + columns: + - + - "Development environment setup" + - "Coding standards and best practices" + - "Pull request guidelines" + - + - "Testing procedures" + - "Documentation guidelines" + - "Community best practices" + + downloads: + id: "downloads" + title: "Downloads" + intro: "Below you'll find official Apache Fineract® releases. We recommend using the latest stable version. Each release includes binary and source distributions with corresponding verification files." + table: + headers: + - "Version" + - "Status" + - "Release Notes" + - "Binary" + - "Source" Review Comment: There are five columns indicated both here and in the `downloads-table` in `site-src/layouts/partials/home-sections.html`, and they'll need to be kept in sync. I think we can simplify this for maintenance, and we should since this the downloads will be the most often updated section. The only important/dynamic data are that 1.14.0 is the current stable, and that 1.13.0 and 1.12.1 are EOL. Can you generate the rest without too much trouble/mess in the download layout/partial? The table headers and wiki, bin, src, asc, and sha512 links for the current stable release should always follow a very specific and consistent URL pattern similar to what is used for 1.14.0. ########## site-src/data/home.yml: ########## @@ -0,0 +1,377 @@ +lang: "en" +title: "Apache Fineract®" +favicon: "images/apache-fineract-icon.png" + +meta: + charset: "UTF-8" + viewport: "width=device-width, initial-scale=1.0" + +body: + id: "top" + class: "ghost-white jet-text" + +styles: + - href: "css/material-icons.css" + type: "text/css" + - href: "css/materialize.min.css" + type: "text/css" + - href: "css/nav-styles.css" + type: "text/css" + - href: "css/fineract.css" + type: "text/css" + +nav: + links: + - label: "About" + href: "#about" + icon: "info" + - label: "Contribute" + href: "#contribute" + icon: "people" + - label: "Downloads" + href: "#downloads" + icon: "download" + - label: "Resources" + href: "#resources" + icon: "library_books" + - label: "Reference" + href: "#reference" + icon: "link" + +homepage: + page_heading: "Apache Fineract®" + platform: + title: "Platform for Digital Financial Services" + intro: + icon: "account_balance" + title: "What is Apache Fineract®?" + text: "Apache Fineract® (\\'fīn-,ә-,rakt\\) is open source software for financial services, designed to create a cloud-ready core banking system that enables digital financial services for everyone, including the unbanked and underbanked." + mission: + icon: "rocket_launch" + title: "Our Mission" + items: + - icon: "cloud_done" + text: "Build and maintain a cloud-ready core banking system" + - icon: "security" + text: "Ensure robust, scalable, and secure operations" + - icon: "accessibility_new" + text: "Promote financial inclusion worldwide" + - icon: "savings" + text: "Enable digital transaction accounts for all" + benefits: + icon: "stars" + title: "Key Benefits" + items: + - icon: "verified" + title: "Reliable" + text: "Proven track record in high-transaction environments" + - icon: "trending_up" + title: "Scalable" + text: "Designed for cloud deployment and growth" + - icon: "savings" + title: "Affordable" + text: "Cost-effective solution for institutions of all sizes" + - icon: "api" + title: "Open APIs" + text: "Headless application design for maximum flexibility" + solution_providers: + title: "For Solution Providers" + intro: "Fineract® 1.x is a cloud-ready platform with open APIs, designed as a headless application.<br>This makes it ideal for solution providers who want to:" + cards: + - icon: "integration_instructions" + title: "Integrate" + text: "Build custom interfaces and extensions" + - icon: "architecture" + title: "Scale" + text: "Deploy cloud-native solutions" + - icon: "hub" + title: "Innovate" + text: "Create unique financial products" + + about: + id: "about" + title: "About - TEST" + intro: + icon: "info" + title: "What is Fineract®?" + text: "Apache Fineract® is a sophisticated core banking system that provides comprehensive financial technology solutions. It offers robust features for client data management, loan and savings portfolio management, integrated real-time accounting, and extensive reporting capabilities." + columns: + - icon: "settings" + title: "Key Features" + items: + - icon: "tune" + title: "Flexible Product Configuration" + text: "Customize financial products to meet your needs" + - icon: "verified_user" + title: "KYC Documentation Support" + text: "Flexible customer system of record" + - icon: "rule" + title: "Business Rule Sets" + text: "Four eyes principles and configurable workflows" + - icon: "payments" + title: "Payment Recognitions" + text: "System of record for repayments" + - icon: "account_balance" + title: "Portfolio Management" + text: "Complete loan and investment tracking" + - icon: "architecture" + title: "Deployment Options" + items: + - icon: "cloud" + title: "Cloud Deployment" + text: "Scalable cloud-based solutions with active community support" + - icon: "computer" + title: "On-Premise" + text: "Legacy or Traditional deployment" + - icon: "phone_iphone" + title: "Mobile Access via Headless Design" + text: "Headless designs allow for third party mobile solutions" + - icon: "api" + title: "Open API" + text: "Comprehensive API support since 2011" + - icon: "extension" + title: "Extensible Architecture" + text: "Support for any organizational type or delivery channel" + notices: + - panel_class: "yellow lighten-4" + icon: "warning" + title: "Important Notice" + intro: "We encourage all users of Fineract® to:" + items: + - "Consult competent technical resources for questions about secure deployment and operation" + - "Review the <a href=\"https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327\";>FAQ</a> and <a href=\"https://fineract.apache.org/docs/current/#_securing_fineract\";>Security Guide</a> for essential setup information" + - "Refer to the Apache license for legal information" + - panel_class: "red lighten-5" + icon: "history" + title: "Deprecated Sub-Project Notice" + text: "The Fineract® CN project (microservice architecture version) was deprecated in May 2023 and archived in late 2023. While this side-project served an important role in describing a microservice approach, it was never officially released." + + contribute: + id: "contribute" + title: "Contribute" + intro_card: + icon: "people" + title: "Join Our Community" + paragraphs: + - "The Apache Fineract® community <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/Contributor%27s+Zone\";>welcomes contributors</a> who want to support the Fineract® technology. Our community builds everything from <a href=\"https://github.com/apache/fineract-site\";>this website</a>, to the <a href=\"https://github.com/apache/fineract\";>Fineract® code</a> to <a href=\"https://github.com/apache/fineract/tree/develop/fineract-doc/src/docs/en/\";>documentation</a> and best practices information." + - "We especially welcome additions and corrections to the documentation, <a href=\"https://cwiki.apache.org/confluence/display/FINERACT/\";>wiki</a>, and website to improve the user experience. Bug reports and fixes and additions to the Apache Fineract® code are welcome. Helping users learn best practices also earns good karma in our community." + - "Security vulnerabilities necessitate special handling: These must be reported privately and immediately to the Apache Fineract® Security Team, via email, to security at fineract.apache.org. Review and follow the <a href=\"https://www.apache.org/security/\"; target=\"_blank\" rel=\"noopener\">Apache Security Team vulnerability reporting guidelines</a>, especially with regard to <a href=\"https://www.apache.org/security/committers.html#possible\"; target=\"_blank\" rel=\"noopener\">working in private</a> prior to public disclosure." Review Comment: Whew, this is getting a bit messy. Maybe this content would be easier to read and maintain in Markdown rather than YAML? What do you think? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
