[
https://issues.apache.org/jira/browse/FINERACT-1592?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17530550#comment-17530550
]
Aleksandar Vidakovic commented on FINERACT-1592:
------------------------------------------------
[~kigred.developer] I am preparing some documentation (meta documentation ;) )
for that at the moment... in 1-2 days I should have some draft that gives some
pointers. That said: things are still moving quite a bit on the documentation
front, but I just rearranged things as part of FINERACT-1470 and am quite happy
with the new structure so far.
The bare minimum you need to know about the documentation:
* it's written in Asciidoc (for those who don't know: a kind of Markdown
language on steroids)
* every chapter is stored in it's own folder and has at least one "index.adoc"
file; most likely with more files for different sections; section files are
included in the "index.adoc" file
* DRY (don't repeat yourself): "usually" when people write - technical -
documentation then they copy and paste a lot of code snippets etc.; in Asciidoc
we don't do that; we have access to all of Fineract's source code and
configuration files and include them as we need (also possible: line ranges
instead of the whole file)
* we have 2 output formats: HTML and PDF
* publishing happens at the moment in intervals (triggered from my local
machine); will be automated soon(-ish)
For now not many (or any) rules concerning the content (structure) exist... so
we have to figure this out a bit while we tag along.
In terms of tooling: Asciidoc has really excellent support via plugins in
IntelliJ, Eclipse and VSCode. Personally I am using IntelliJ and VSCode to
write documentation; both of them have excellent preview capabilities so you
can immediately check what your content will look like.
There are a ton of tips and tricks that are too long to repeat here, but to get
started you just need to know a handful of Asciidoc concepts (headers, bullet
lists, numbered lists, source code sections, how to include files...); with
those you can create already some impressive content. And most beautiful of
all: you don't have to worry about layout, rendering, styles etc. etc. (well,
at least not that much). Very distraction free compared to e. g. Word documents
(shudder).
So, if you want to prepare a bit then just head over to [https://asciidoc.org/]
read a bit the documentation.
> Hikari Pool connection timed out. Tomcat crashes users cannot log in after
> --------------------------------------------------------------------------
>
> Key: FINERACT-1592
> URL: https://issues.apache.org/jira/browse/FINERACT-1592
> Project: Apache Fineract
> Issue Type: Bug
> Components: Performance, Reports
> Affects Versions: 1.6.0
> Reporter: Francis Guchie
> Assignee: Francis Guchie
> Priority: Major
> Attachments: image-2022-04-22-11-25-32-303.png
>
>
> !image-2022-04-22-11-25-32-303.png!
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
