Skip to content

Commit

Permalink
FINERACT-2170: improve asciidoc: clean URIs, more (apache#4271)
Browse files Browse the repository at this point in the history
* disable broken fineract-client API asciidoc include
  * this has a side effect of removing ~1,200 pages from the PDF
* remove duplicated/outdated text, reduce sources of truth
  * link to current FAQ
  * introduction is all references now... it was way out of date and also needed formatting fixes
* unset `show-link-uri` to improve PDF rendering
* remove unnecessary/unused `.asciidoctorconfig` file
  • Loading branch information
meonkeys authored Jan 29, 2025
1 parent 66f3de8 commit 8b80f5a
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 79 deletions.
1 change: 0 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,6 @@ allprojects {
'**/licenses/**',
'**/*.md',
'**/*.adoc',
'**/.asciidoctorconfig',
'**/*.puml',
'**/*.github/**',
'**/MANIFEST.MF',
Expand Down
8 changes: 0 additions & 8 deletions fineract-doc/.asciidoctorconfig

This file was deleted.

3 changes: 2 additions & 1 deletion fineract-doc/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@ asciidoctorj {

attributes = [
version: "${project.version}",
docdate: new Date(),
generated: "${buildDir}/generated/asciidoc",
imagesdir: "${buildDir}/generated/images",
diagramsdir: "${buildDir}/generated/diagrams",
years: '2015-2024',
years: '2015-2025',
revnumber: "${project.version}".toString(),
rootdir: "${rootDir}".toString(),
baseurl: 'fineract.apache.org',
Expand Down
39 changes: 2 additions & 37 deletions fineract-doc/src/docs/en/colophon.adoc
Original file line number Diff line number Diff line change
@@ -1,44 +1,9 @@
[colophon]

//ifdef::backend-pdf[]
//{empty} +
//endif::[]

*Version*: {revnumber}

*Date*: {docdate}

//ifdef::backend-pdf[]
//{empty} +
//endif::[]

.Authors
|===
^| Name ^| Email

| Michael Vorburger | mailto:[email protected][]
| Aleksandar Vidakovic | mailto:[email protected][]
| Arnold Galovics | mailto:[email protected][]
| Adam Saghy | mailto:[email protected][]
|===

//ifdef::backend-pdf[]
//{empty} +
//endif::[]

.History
[cols="<.^2a,<.^4a,^.^2a,^.^1a"]
|===
^| Authors ^| Description ^| Date ^| Version
*Built on*: {docdate}

| Aleksandar Vidakovic | Initial version | 2020-10-26 | 1.4.0
| Arnold Galovics | Database architecture section | 2022-03-11 | 1.7.0
| Aleksandar Vidakovic | Module section | 2022-03-23 | 1.7.0
| Aleksandar Vidakovic | Release section, file re-organisation | 2022-04-18 | 1.7.0
| Arnold Galovics | Spring Batch | 2022-03-11 | 1.7.0
| Aleksandar Vidakovic | AsciiDoc cheatsheet | 2022-05-09 | 1.7.0
| Adam Saghy | Business data | 2022-06-13 | 1.7.0
| Aleksandar Vidakovic | Custom modules and extensions | 2022-10-29 | 1.8.0
|===
For document authors and changelog, view code history for the `fineract-doc` directory in https://github.com/apache/fineract/.

toc::[]
2 changes: 1 addition & 1 deletion fineract-doc/src/docs/en/faq.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[faq]
= Frequently Asked Questions

TBD
See https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327[Fineract FAQ wiki page].
13 changes: 12 additions & 1 deletion fineract-doc/src/docs/en/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@

:doctitle: Fineract Platform Documentation

// Never show URI for named links.
// There's no need as long as all of our output formats are digital (hence, click/touch-able).
// Only applies to PDF backend.
:!show-link-uri:

include::config.adoc[]

= Fineract Documentation
Expand Down Expand Up @@ -51,12 +56,18 @@ include::chapters/release/index.adoc[leveloffset=+1]

include::chapters/sdk/index.adoc[leveloffset=+1]

include::fineract-client.adoc[leveloffset=+1]
// Broken: asciidoc is only partially rendered.
//include::fineract-client.adoc[leveloffset=+1]

include::faq.adoc[leveloffset=+1]

include::glossary.adoc[leveloffset=+1]

// See https://docs.asciidoctor.org/asciidoc/latest/sections/user-index/ .
// Limit this to PDF because the HTML backend can't (yet) create an index.
// Also, we don't yet have any indexed terms, so it might make more sense to remove the index even for PDF.
ifdef::backend-pdf[]
include::indices.adoc[leveloffset=+1]
endif::[]

include::chapters/appendix/index.adoc[]
37 changes: 7 additions & 30 deletions fineract-doc/src/docs/en/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,21 @@

== Platform for Digital Financial Services

Apache Fineract (\’fīn-,ә-,rakt\) is open source software for financial services.

Fineract provides a reliable, robust, and affordable solution for entrepreneurs, financial institutions, and service providers to offer financial services to the world’s 2 billion underbanked and unbanked. Fineract is aimed at innovative mobile and cloud-based solutions, and enables digital transaction accounts for all.

Fineract 1.x is a mature platform with open APIs.

```
image:https://static.scarf.sh/a.png?x-pxid=c8fb6966-9836-4ad6-882f-0461000fcbc7[]
```


See https://fineract.apache.org

== About

Apache Fineract can be deployed in any environment: cloud or on-premise. It can support front end interfaces on or offline, mobile or PC. It’s extensible enough to support any organizational type or delivery channel, and flexible enough to support any product, service, or lending methodology. For any organization, big or small, it provides the client data management, loan and savings portfolio management, integrated real time accounting, and social and financial reporting needed to bring digital financial services to a modern connected world.

Fineract 1.x compares well to other core banking systems and draws from requirements in credit unions, microfinance institutions, and small non-banking financial institutions. Features include flexible product configuration, KYC documentation support, business rule sets, payment transactions, and portfolio management. It includes an open API that dates to 2011 and is deployed in relatively high transaction volume environments.

Fineract CN operates on the principle that financial services are an innovative space and so each fineract microservice encapsulates a domain that can be combined with other microservices to create new platform offerings. Fineract CN microservices can be combined to create new software platforms for digital financial service providers. Fineract CN is still in its early days, but preliminary tests have shown that a simple single-instance laptop deployment of Fineract CN can process over 1000 transactions/second. Fineract CN also includes a fully Apache-licensed backoffice UI.

Fineract 1.x began incubation at Apache in December 2015 and is used by an active community of companies who build solutions for both financial inclusion and fintech innovation.
See https://fineract.apache.org/#about

== Contribute

The Apache Fineract community welcomes contributors who want to support the Fineract technology. Our community builds everything from this website, to the Fineract code to documentation and best practices information.
See https://fineract.apache.org/#contribute

We especially welcome additions and corrections to the documentation, wiki, 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.
== Downloads

== Mailing Lists
See https://fineract.apache.org/#downloads

Users & Developers
== Resources

If you use, build on top of, deploy or are building contributions and modifications to Apache Fineract, this is the list for you.
To subscribe, send a blank email to [email protected].
To unsubscribe later, just send a blank email to [email protected].
You can also read the archives on lists.apache.org or on MarkMail.org.
Commits
See https://fineract.apache.org/#resources

This list receives an email whenever new code is contributed to Apache Fineract.
To subscribe, send a blank email to [email protected].
You can also read the archives.

0 comments on commit 8b80f5a

Please sign in to comment.