This is an automated email from the ASF dual-hosted git repository.
victorromero pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/fineract.git
The following commit(s) were added to refs/heads/develop by this push:
new 8b80f5a93 FINERACT-2170: improve asciidoc: clean URIs, more (#4271)
8b80f5a93 is described below
commit 8b80f5a934461224f9c67ae88d6c55fdee27c9ec
Author: Adam Monsen <[email protected]>
AuthorDate: Wed Jan 29 10:41:34 2025 -0800
FINERACT-2170: improve asciidoc: clean URIs, more (#4271)
* 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
---
build.gradle | 1 -
fineract-doc/.asciidoctorconfig | 8 ------
fineract-doc/build.gradle | 3 ++-
fineract-doc/src/docs/en/colophon.adoc | 39 ++----------------------------
fineract-doc/src/docs/en/faq.adoc | 2 +-
fineract-doc/src/docs/en/index.adoc | 13 +++++++++-
fineract-doc/src/docs/en/introduction.adoc | 37 ++++++----------------------
7 files changed, 24 insertions(+), 79 deletions(-)
diff --git a/build.gradle b/build.gradle
index f743d4efc..52c811c5e 100644
--- a/build.gradle
+++ b/build.gradle
@@ -249,7 +249,6 @@ allprojects {
'**/licenses/**',
'**/*.md',
'**/*.adoc',
- '**/.asciidoctorconfig',
'**/*.puml',
'**/*.github/**',
'**/MANIFEST.MF',
diff --git a/fineract-doc/.asciidoctorconfig b/fineract-doc/.asciidoctorconfig
deleted file mode 100644
index c6fcc35fe..000000000
--- a/fineract-doc/.asciidoctorconfig
+++ /dev/null
@@ -1,8 +0,0 @@
-:years: 2015-2024
-:revnumber: 1.9.0-xxxx
-:draft: true
-:rootdir: {asciidoctorconfigdir}/..
-:generated: {asciidoctorconfigdir}/build/generated/asciidoc
-:diagramsdir: {asciidoctorconfigdir}/src/docs/en/diagrams
-:imagesdir: {asciidoctorconfigdir}/src/docs/en/images
-:icons: font
diff --git a/fineract-doc/build.gradle b/fineract-doc/build.gradle
index 0504c6ed8..67ce8887d 100644
--- a/fineract-doc/build.gradle
+++ b/fineract-doc/build.gradle
@@ -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',
diff --git a/fineract-doc/src/docs/en/colophon.adoc
b/fineract-doc/src/docs/en/colophon.adoc
index c9a917891..a58c229b2 100644
--- a/fineract-doc/src/docs/en/colophon.adoc
+++ b/fineract-doc/src/docs/en/colophon.adoc
@@ -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::[]
diff --git a/fineract-doc/src/docs/en/faq.adoc
b/fineract-doc/src/docs/en/faq.adoc
index 9052177aa..9c4fa1dd9 100644
--- a/fineract-doc/src/docs/en/faq.adoc
+++ b/fineract-doc/src/docs/en/faq.adoc
@@ -1,4 +1,4 @@
[faq]
= Frequently Asked Questions
-TBD
+See
https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=91554327[Fineract
FAQ wiki page].
diff --git a/fineract-doc/src/docs/en/index.adoc
b/fineract-doc/src/docs/en/index.adoc
index 2c038fe33..325360b5e 100644
--- a/fineract-doc/src/docs/en/index.adoc
+++ b/fineract-doc/src/docs/en/index.adoc
@@ -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
@@ -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[]
diff --git a/fineract-doc/src/docs/en/introduction.adoc
b/fineract-doc/src/docs/en/introduction.adoc
index 6e68b1784..7f02692fe 100644
--- a/fineract-doc/src/docs/en/introduction.adoc
+++ b/fineract-doc/src/docs/en/introduction.adoc
@@ -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 [...]
-
-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 1 [...]
-
-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.
