You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@fineract.apache.org by James Dailey <ja...@gmail.com> on 2023/06/16 19:43:05 UTC
Fineract website
repo:apache/fineract-site
serves up as https://fineract.apache.org
so, it's just a simple javascript index.html
why?
Related: Please see email threads on wiki and website improvements.
https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
<https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
and
https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com> wrote:
> Cool. this all looks good. will chip away at working my way through it.
> Curious, how is fineract.apache.org served?
>
> -Rob
>
>
>>
Re: Fineract website
Posted by Rob Tompkins <ch...@gmail.com>.
Cool!
> On Jun 16, 2023, at 3:43 PM, James Dailey <ja...@gmail.com> wrote:
>
>
>
>
> repo:apache/fineract-site
>
>
>
>
> serves up as <https://fineract.apache.org>
>
>
>
>
>
> so, it's just a simple javascript index.html
>
>
>
>
> why?
>
>
>
>
> Related: Please see email threads on wiki and website improvements.
>
> [https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
> ](https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8)
>
> and
>
> <https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz>
>
>
>
>
>
>
>
>
>
>
> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins
> <[chtompki@gmail.com](mailto:chtompki@gmail.com)> wrote:
>
>
>> Cool. this all looks good. will chip away at working my way through it.
Curious, how is [fineract.apache.org](http://fineract.apache.org) served?
>>
>>
>
>>
>> -Rob
>>
>>> >
>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
@James Dailey <ja...@gmail.com> Please convene a meeting similar to
the one we had previously to discuss this...I'll showcase what I have done
so far with regards to migrating docs to asciidoc. 1pm EST Wed works for me.
The outcome of the meeting would be to have all interested stakeholders
well aligned and to have more people contribute to this very important part
of the project.
On Mon, Jun 26, 2023 at 8:29 AM John Gathogo <jo...@fiter.io> wrote:
> Hello Inzemamul,
>
> I get you now. Yes, we can customize the default theme and align it with
> fineract colors, theme and so on. Is this something you are willing to do?
>
> Thanks
>
> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> Hello John,
>> What I am trying to say is that antora is based on react/node so we have
>> to code the landing page in react??
>>
>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>
>>> Hello Inzemamul,
>>>
>>> It's possible to generate the landing page with asciidoc and antora,
>>> this is my preference but it's up to the community. Let's see what the
>>> other people say.
>>>
>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> Hello John!
>>>> What I am getting is that the ANTORA will be used to manage the
>>>> documentation like a cms or static site generator. and we Have to create
>>>> the landing page with ourself using REACT am I correct?
>>>> Regards,
>>>> Inzemamul Haq
>>>>
>>>>
>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>
>>>>> I believe there is consensus to use ascii doc as the documentation
>>>>> language because of all its benefits. A lot of work has gone into this so
>>>>> far, thanks to Aleks and others.
>>>>>
>>>>> With this in mind, I am working on putting in place the mechanics to
>>>>> have the asciidoc files rendered using Antora.
>>>>>
>>>>> With Antora in place, the docs landing page will also be written in
>>>>> asciidoc.
>>>>>
>>>>> Hope this helps to clarify things.
>>>>>
>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> John and Inzemamul
>>>>>>
>>>>>> Both of you seem to be working on something related to the finerat
>>>>>> website, so please be sure that your work remains aligned.
>>>>>> One way to do that is to describe, here, what the steps are that you
>>>>>> are doing or are about to do.
>>>>>>
>>>>>> Another way is to open a ticket and self assign it to yourself with
>>>>>> certain descriptions of again, things you will be working on or things you
>>>>>> have already done.
>>>>>> For the website, we don't strictly need a fineract jira ticket, but
>>>>>> it wouldn't hurt.
>>>>>>
>>>>>> Thanks,
>>>>>> James
>>>>>>
>>>>>>
>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>>>>>
>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>
>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>
>>>>>>>>
>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>>>>
>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>
>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>
>>>>>>>>> Thanks
>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>
>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>>>>>> changes on the site.
>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show you
>>>>>>>>>> the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>> Regards,
>>>>>>>>>> Inzemam
>>>>>>>>>>
>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>
>>>>>>>>>>> Inzemamul
>>>>>>>>>>>
>>>>>>>>>>> Are you saying you are building this for Fineract? And that it
>>>>>>>>>>> is close to being pushed ?
>>>>>>>>>>>
>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>
>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> And as far as I have completed the landing page is on HTML,CSS
>>>>>>>>>>>> and Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>>>>> will update it on the website.
>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I prefer
>>>>>>>>>>>> is NEXT JS as it's most easy to manage via github). The idea of edit this
>>>>>>>>>>>> page will require the backend so there we needed either the LAMP stack or
>>>>>>>>>>>> the MERN/MEAN stack.
>>>>>>>>>>>> Regards,
>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>
>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>
>>>>>>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>>>>>>> udates to Github.
>>>>>>>>>>>>>
>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>
>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> Having said that: I think it would be great to have a static
>>>>>>>>>>>>> site generator to manage all pages of the Fineract site. Apache Camel is -
>>>>>>>>>>>>> I think - doing a great job managing their web site. It's a combination of
>>>>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of
>>>>>>>>>>>>> this into one coherent site. What I find really great about this approach:
>>>>>>>>>>>>> every page has a Git reference; on pretty much every page you can see a
>>>>>>>>>>>>> link "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>
>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>
>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>
>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Where should we be updating the documentation? i.e. let's
>>>>>>>>>>>>> say we want to add "how to build"
>>>>>>>>>>>>>
>>>>>>>>>>>>> james
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> --
>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>
>>>>>>>>>>> --
>>>>>>>> Sent from Gmail Mobile
>>>>>>>>
>>>>>>>
Re: Fineract website
Posted by Carolina Huczek <ca...@fiter.io>.
Hi guys,
Thank you for the update!!
@Inzemamul Haq <in...@gmail.com> nice to meet you!! I'm Carolina,
Head of Marketing & Growth at Fiter. I've been talking with John about
giving you support with the rebranding of the website. I'm not able to add
comments in the conversation you've already had but feel free to contact me
whenever you need. If you'd like to share a link so I can take a look at
the design, that would be great!!
Thanks!!
[image: Logo] <https://www.fiter.io>
*Caro Huczek* *| Head of Marketing & Growth*
*e:* carolina@fiter.io
*w:* fiter.io <http://www.fiter.io>
*m:* +54 1154731483
[image: twitter icon] <https://twitter.com/Fiter_io> [image: youtube icon]
<https://www.youtube.com/channel/UCfWztdFtHI3PwaSLAEcwTNQ> [image: linkedin
icon] <https://www.linkedin.com/company/fiter-io>
On Thu, Aug 10, 2023 at 12:49 PM John Gathogo <jo...@fiter.io> wrote:
> Hello everyone,
>
> Quick update
>
> I have migrated the following content from the wiki to asciidoc:
>
> - Contributor zone
> - Committer zone
> - Project overview
>
> Please review here and advise http://34.125.49.167/modules/1.8/index.html
>
> The content has been migrated as is, this email is to call for review of
> the content for correctness and updatedness. A PR will be raised by the end
> of this week for people to make corrections.
>
> @Inzemamul Haq <in...@gmail.com> how the UI/landing page works
> coming along.
>
> Am thinking we should aim to have documentation migrated to ascii format
> by the end of this month.
>
> Thanks,
> Ruhiu
>
> On Mon, Jul 31, 2023 at 12:28 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> John currently it's implemented in html/css but when the design will be
>> finalized then I'll do it on antora hardly it'll take 1-2hrs to complete.
>> But now we have to finalize the design.
>> Regards,
>> Inzemam
>>
>> On Mon, 31 Jul, 2023, 12:20 pm John Gathogo, <jo...@fiter.io> wrote:
>>
>>> Hello Inzemamul,
>>>
>>> I think we agreed to use Antora to generate the documentation website
>>> from asciidoc pages, including the landing page. Is this the customized
>>> antora theme?
>>>
>>> Thanks,
>>> Ruhiu
>>>
>>> On Sat, Jul 29, 2023 at 8:43 PM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> The wiki will be dynamic and I am working on a script which'll fetch
>>>> the data from the wiki or confluence.
>>>> Can someone share the links with me so I can start?
>>>> Also James I am looking forward to working on the apache fineract and
>>>> want to contribute to the upcoming GSoC next year. Basically I am good at
>>>> Javascript as well as android development so what can I try? Are there any
>>>> suggestions?
>>>> Regards,
>>>> Inzemamul Haq
>>>>
>>>> On Sat, Jul 29, 2023 at 10:45 PM James Dailey <ja...@gmail.com>
>>>> wrote:
>>>>
>>>>> Thanks! It looks great.
>>>>>
>>>>> Does anyone else have suggestions?
>>>>> Otherwise we can proceed.
>>>>>
>>>>> A key thing about the wiki is that it is trivial to update. How does
>>>>> one make changes to this site? Can you walk through a change?
>>>>>
>>>>> I think we should keep our more dynamic content on the wiki. Yes?
>>>>>
>>>>>
>>>>>
>>>>> On Sat, Jul 29, 2023 at 9:15 AM Inzemamul Haq <in...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Hi James,
>>>>>> I have created some changes and added `
>>>>>> https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract`
>>>>>> <https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract>
>>>>>> there please have a look and lemme know
>>>>>> regards,
>>>>>> Inzemam
>>>>>>
>>>>>> On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Opps. That was John's video.
>>>>>>>
>>>>>>> Haq - Please share your Landing Page design.... not sure how that
>>>>>>> can work with asciidocs / antora doing the "artifacts". But, please
>>>>>>> forward your ideas, share a video, explain what you've been working on. If
>>>>>>> you are ok with using the approach that John has outlined, a simple +1
>>>>>>> would suffice.
>>>>>>>
>>>>>>> You two are free to discuss privately and bring back to the list. I
>>>>>>> am not able to set up a time that works for me and your timezones this week
>>>>>>> or next.
>>>>>>>
>>>>>>> Can you push a PR so we can see that, review it?
>>>>>>>
>>>>>>> It might be easier to put the infrastructure concept in place first
>>>>>>> and then make adjustments with graphical elements and artifacts.
>>>>>>>
>>>>>>>
>>>>>>> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <
>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>
>>>>>>>> I think this is moving along nicely. Let’s see if we can’t use
>>>>>>>> email and/or the Apache Fineract slack to coordinate.
>>>>>>>>
>>>>>>>> Please outline your idea here John, after seeing Haqs video
>>>>>>>>
>>>>>>>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <
>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> Hey John!
>>>>>>>>>
>>>>>>>>> Yep I have created the new landing page but as previously
>>>>>>>>> discussed I created that in HTML/CSS/JS now if the community will agree
>>>>>>>>> then we can do it in Antora. I can work on that too.
>>>>>>>>>
>>>>>>>>> Also I am totally agreed with your idea as the asciidocs and the
>>>>>>>>> antora (based on react/node) will give a smooth flow of management.
>>>>>>>>> Regards,
>>>>>>>>> Inzemamul Haq
>>>>>>>>>
>>>>>>>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io>
>>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> Hello Inzemamul,
>>>>>>>>>>
>>>>>>>>>> I get you now. Yes, we can customize the default theme and align
>>>>>>>>>> it with fineract colors, theme and so on. Is this something you are willing
>>>>>>>>>> to do?
>>>>>>>>>>
>>>>>>>>>> Thanks
>>>>>>>>>>
>>>>>>>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <
>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> Hello John,
>>>>>>>>>>> What I am trying to say is that antora is based on react/node so
>>>>>>>>>>> we have to code the landing page in react??
>>>>>>>>>>>
>>>>>>>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Hello Inzemamul,
>>>>>>>>>>>>
>>>>>>>>>>>> It's possible to generate the landing page with asciidoc and
>>>>>>>>>>>> antora, this is my preference but it's up to the community. Let's see what
>>>>>>>>>>>> the other people say.
>>>>>>>>>>>>
>>>>>>>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <
>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> Hello John!
>>>>>>>>>>>>> What I am getting is that the ANTORA will be used to manage
>>>>>>>>>>>>> the documentation like a cms or static site generator. and we Have to
>>>>>>>>>>>>> create the landing page with ourself using REACT am I correct?
>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io>
>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> I believe there is consensus to use ascii doc as the
>>>>>>>>>>>>>> documentation language because of all its benefits. A lot of work has gone
>>>>>>>>>>>>>> into this so far, thanks to Aleks and others.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> With this in mind, I am working on putting in place the
>>>>>>>>>>>>>> mechanics to have the asciidoc files rendered using Antora.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> With Antora in place, the docs landing page will also be
>>>>>>>>>>>>>> written in asciidoc.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Hope this helps to clarify things.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> John and Inzemamul
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Both of you seem to be working on something related to the
>>>>>>>>>>>>>>> finerat website, so please be sure that your work remains aligned.
>>>>>>>>>>>>>>> One way to do that is to describe, here, what the steps are
>>>>>>>>>>>>>>> that you are doing or are about to do.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Another way is to open a ticket and self assign it to
>>>>>>>>>>>>>>> yourself with certain descriptions of again, things you will be working on
>>>>>>>>>>>>>>> or things you have already done.
>>>>>>>>>>>>>>> For the website, we don't strictly need a fineract jira
>>>>>>>>>>>>>>> ticket, but it wouldn't hurt.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Thanks,
>>>>>>>>>>>>>>> James
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <
>>>>>>>>>>>>>>>>> john@fiter.io> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice
>>>>>>>>>>>>>>>>>> for generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> I support the use of antora to generate the landing and
>>>>>>>>>>>>>>>>>> other pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Thanks
>>>>>>>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to
>>>>>>>>>>>>>>>>>>> tweak the changes on the site.
>>>>>>>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't
>>>>>>>>>>>>>>>>>>> show you the part but surely when I'll get my pc back will show the demo
>>>>>>>>>>>>>>>>>>> asap.
>>>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> ... is there somewhere a preview available of that new
>>>>>>>>>>>>>>>>>>>> stuff?
>>>>>>>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And
>>>>>>>>>>>>>>>>>>>> that it is close to being pushed ?
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what
>>>>>>>>>>>>>>>>>>>>> I prefer is NEXT JS as it's most easy to manage via github). The idea of
>>>>>>>>>>>>>>>>>>>>> edit this page will require the backend so there we needed either the LAMP
>>>>>>>>>>>>>>>>>>>>> stack or the MERN/MEAN stack.
>>>>>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to
>>>>>>>>>>>>>>>>>>>>>> the Github repo
>>>>>>>>>>>>>>>>>>>>>> "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> The documentation in HTML format under the "current"
>>>>>>>>>>>>>>>>>>>>>> folder is generated from the AsciiDoc (kind of a Markdown on steroids
>>>>>>>>>>>>>>>>>>>>>> format) files. Publishing again is a simple copy to the fineract-site repo
>>>>>>>>>>>>>>>>>>>>>> and pushing the udates to Github.
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a
>>>>>>>>>>>>>>>>>>>>>> while ago). As part of our release process we ship the current
>>>>>>>>>>>>>>>>>>>>>> documentation in PDF (another output format of AsciiDoc) with the
>>>>>>>>>>>>>>>>>>>>>> downloadable release artifacts (tar.gz files).
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the
>>>>>>>>>>>>>>>>>>>>>> Fineract database schema, tables, columns, relationships that are generated
>>>>>>>>>>>>>>>>>>>>>> by another command line tool (SchemaCrawler). I think I generated these
>>>>>>>>>>>>>>>>>>>>>> pages only a handful of times; at the moment not automated... and no
>>>>>>>>>>>>>>>>>>>>>> feedback if people find this useful or not. It would be great if they could
>>>>>>>>>>>>>>>>>>>>>> generate AsciiDoc instead of HTML only... then we could include this also
>>>>>>>>>>>>>>>>>>>>>> in the PDF documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e.
>>>>>>>>>>>>>>>>>>>>>> let's say we want to add "how to build"
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and
>>>>>>>>>>>>>>>>>>>>>>> website improvements.
>>>>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at
>>>>>>>>>>>>>>>>>>>>>>>> working my way through it. Curious, how is
>>>>>>>>>>>>>>>>>>>>>>>> fineract.apache.org served?
>>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> --
>>>>>>>> Sent from Gmail Mobile
>>>>>>>>
>>>>>>> --
>>>>> Sent from Gmail Mobile
>>>>>
>>>>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
Hello everyone,
Quick update
I have migrated the following content from the wiki to asciidoc:
- Contributor zone
- Committer zone
- Project overview
Please review here and advise http://34.125.49.167/modules/1.8/index.html
The content has been migrated as is, this email is to call for review of
the content for correctness and updatedness. A PR will be raised by the end
of this week for people to make corrections.
@Inzemamul Haq <in...@gmail.com> how the UI/landing page works
coming along.
Am thinking we should aim to have documentation migrated to ascii format by
the end of this month.
Thanks,
Ruhiu
On Mon, Jul 31, 2023 at 12:28 PM Inzemamul Haq <in...@gmail.com>
wrote:
> John currently it's implemented in html/css but when the design will be
> finalized then I'll do it on antora hardly it'll take 1-2hrs to complete.
> But now we have to finalize the design.
> Regards,
> Inzemam
>
> On Mon, 31 Jul, 2023, 12:20 pm John Gathogo, <jo...@fiter.io> wrote:
>
>> Hello Inzemamul,
>>
>> I think we agreed to use Antora to generate the documentation website
>> from asciidoc pages, including the landing page. Is this the customized
>> antora theme?
>>
>> Thanks,
>> Ruhiu
>>
>> On Sat, Jul 29, 2023 at 8:43 PM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> The wiki will be dynamic and I am working on a script which'll fetch the
>>> data from the wiki or confluence.
>>> Can someone share the links with me so I can start?
>>> Also James I am looking forward to working on the apache fineract and
>>> want to contribute to the upcoming GSoC next year. Basically I am good at
>>> Javascript as well as android development so what can I try? Are there any
>>> suggestions?
>>> Regards,
>>> Inzemamul Haq
>>>
>>> On Sat, Jul 29, 2023 at 10:45 PM James Dailey <ja...@gmail.com>
>>> wrote:
>>>
>>>> Thanks! It looks great.
>>>>
>>>> Does anyone else have suggestions?
>>>> Otherwise we can proceed.
>>>>
>>>> A key thing about the wiki is that it is trivial to update. How does
>>>> one make changes to this site? Can you walk through a change?
>>>>
>>>> I think we should keep our more dynamic content on the wiki. Yes?
>>>>
>>>>
>>>>
>>>> On Sat, Jul 29, 2023 at 9:15 AM Inzemamul Haq <in...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hi James,
>>>>> I have created some changes and added `
>>>>> https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract`
>>>>> <https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract>
>>>>> there please have a look and lemme know
>>>>> regards,
>>>>> Inzemam
>>>>>
>>>>> On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Opps. That was John's video.
>>>>>>
>>>>>> Haq - Please share your Landing Page design.... not sure how that can
>>>>>> work with asciidocs / antora doing the "artifacts". But, please forward
>>>>>> your ideas, share a video, explain what you've been working on. If you are
>>>>>> ok with using the approach that John has outlined, a simple +1 would
>>>>>> suffice.
>>>>>>
>>>>>> You two are free to discuss privately and bring back to the list. I
>>>>>> am not able to set up a time that works for me and your timezones this week
>>>>>> or next.
>>>>>>
>>>>>> Can you push a PR so we can see that, review it?
>>>>>>
>>>>>> It might be easier to put the infrastructure concept in place first
>>>>>> and then make adjustments with graphical elements and artifacts.
>>>>>>
>>>>>>
>>>>>> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> I think this is moving along nicely. Let’s see if we can’t use
>>>>>>> email and/or the Apache Fineract slack to coordinate.
>>>>>>>
>>>>>>> Please outline your idea here John, after seeing Haqs video
>>>>>>>
>>>>>>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <
>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>
>>>>>>>> Hey John!
>>>>>>>>
>>>>>>>> Yep I have created the new landing page but as previously discussed
>>>>>>>> I created that in HTML/CSS/JS now if the community will agree then we can
>>>>>>>> do it in Antora. I can work on that too.
>>>>>>>>
>>>>>>>> Also I am totally agreed with your idea as the asciidocs and the
>>>>>>>> antora (based on react/node) will give a smooth flow of management.
>>>>>>>> Regards,
>>>>>>>> Inzemamul Haq
>>>>>>>>
>>>>>>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>>>>>>>
>>>>>>>>> Hello Inzemamul,
>>>>>>>>>
>>>>>>>>> I get you now. Yes, we can customize the default theme and align
>>>>>>>>> it with fineract colors, theme and so on. Is this something you are willing
>>>>>>>>> to do?
>>>>>>>>>
>>>>>>>>> Thanks
>>>>>>>>>
>>>>>>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <
>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> Hello John,
>>>>>>>>>> What I am trying to say is that antora is based on react/node so
>>>>>>>>>> we have to code the landing page in react??
>>>>>>>>>>
>>>>>>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> Hello Inzemamul,
>>>>>>>>>>>
>>>>>>>>>>> It's possible to generate the landing page with asciidoc and
>>>>>>>>>>> antora, this is my preference but it's up to the community. Let's see what
>>>>>>>>>>> the other people say.
>>>>>>>>>>>
>>>>>>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <
>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Hello John!
>>>>>>>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>>>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>>>>>>>> the landing page with ourself using REACT am I correct?
>>>>>>>>>>>> Regards,
>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io>
>>>>>>>>>>>> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> I believe there is consensus to use ascii doc as the
>>>>>>>>>>>>> documentation language because of all its benefits. A lot of work has gone
>>>>>>>>>>>>> into this so far, thanks to Aleks and others.
>>>>>>>>>>>>>
>>>>>>>>>>>>> With this in mind, I am working on putting in place the
>>>>>>>>>>>>> mechanics to have the asciidoc files rendered using Antora.
>>>>>>>>>>>>>
>>>>>>>>>>>>> With Antora in place, the docs landing page will also be
>>>>>>>>>>>>> written in asciidoc.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Hope this helps to clarify things.
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> John and Inzemamul
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Both of you seem to be working on something related to the
>>>>>>>>>>>>>> finerat website, so please be sure that your work remains aligned.
>>>>>>>>>>>>>> One way to do that is to describe, here, what the steps are
>>>>>>>>>>>>>> that you are doing or are about to do.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Another way is to open a ticket and self assign it to
>>>>>>>>>>>>>> yourself with certain descriptions of again, things you will be working on
>>>>>>>>>>>>>> or things you have already done.
>>>>>>>>>>>>>> For the website, we don't strictly need a fineract jira
>>>>>>>>>>>>>> ticket, but it wouldn't hurt.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Thanks,
>>>>>>>>>>>>>> James
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice
>>>>>>>>>>>>>>>>> for generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> I support the use of antora to generate the landing and
>>>>>>>>>>>>>>>>> other pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Thanks
>>>>>>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to
>>>>>>>>>>>>>>>>>> tweak the changes on the site.
>>>>>>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't
>>>>>>>>>>>>>>>>>> show you the part but surely when I'll get my pc back will show the demo
>>>>>>>>>>>>>>>>>> asap.
>>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> ... is there somewhere a preview available of that new
>>>>>>>>>>>>>>>>>>> stuff?
>>>>>>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And
>>>>>>>>>>>>>>>>>>> that it is close to being pushed ?
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what
>>>>>>>>>>>>>>>>>>>> I prefer is NEXT JS as it's most easy to manage via github). The idea of
>>>>>>>>>>>>>>>>>>>> edit this page will require the backend so there we needed either the LAMP
>>>>>>>>>>>>>>>>>>>> stack or the MERN/MEAN stack.
>>>>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to
>>>>>>>>>>>>>>>>>>>>> the Github repo
>>>>>>>>>>>>>>>>>>>>> "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> The documentation in HTML format under the "current"
>>>>>>>>>>>>>>>>>>>>> folder is generated from the AsciiDoc (kind of a Markdown on steroids
>>>>>>>>>>>>>>>>>>>>> format) files. Publishing again is a simple copy to the fineract-site repo
>>>>>>>>>>>>>>>>>>>>> and pushing the udates to Github.
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a
>>>>>>>>>>>>>>>>>>>>> while ago). As part of our release process we ship the current
>>>>>>>>>>>>>>>>>>>>> documentation in PDF (another output format of AsciiDoc) with the
>>>>>>>>>>>>>>>>>>>>> downloadable release artifacts (tar.gz files).
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the
>>>>>>>>>>>>>>>>>>>>> Fineract database schema, tables, columns, relationships that are generated
>>>>>>>>>>>>>>>>>>>>> by another command line tool (SchemaCrawler). I think I generated these
>>>>>>>>>>>>>>>>>>>>> pages only a handful of times; at the moment not automated... and no
>>>>>>>>>>>>>>>>>>>>> feedback if people find this useful or not. It would be great if they could
>>>>>>>>>>>>>>>>>>>>> generate AsciiDoc instead of HTML only... then we could include this also
>>>>>>>>>>>>>>>>>>>>> in the PDF documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e.
>>>>>>>>>>>>>>>>>>>>> let's say we want to add "how to build"
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and
>>>>>>>>>>>>>>>>>>>>>> website improvements.
>>>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working
>>>>>>>>>>>>>>>>>>>>>>> my way through it. Curious, how is
>>>>>>>>>>>>>>>>>>>>>>> fineract.apache.org served?
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> --
>>>>>>> Sent from Gmail Mobile
>>>>>>>
>>>>>> --
>>>> Sent from Gmail Mobile
>>>>
>>>
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
John currently it's implemented in html/css but when the design will be
finalized then I'll do it on antora hardly it'll take 1-2hrs to complete.
But now we have to finalize the design.
Regards,
Inzemam
On Mon, 31 Jul, 2023, 12:20 pm John Gathogo, <jo...@fiter.io> wrote:
> Hello Inzemamul,
>
> I think we agreed to use Antora to generate the documentation website from
> asciidoc pages, including the landing page. Is this the customized antora
> theme?
>
> Thanks,
> Ruhiu
>
> On Sat, Jul 29, 2023 at 8:43 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> The wiki will be dynamic and I am working on a script which'll fetch the
>> data from the wiki or confluence.
>> Can someone share the links with me so I can start?
>> Also James I am looking forward to working on the apache fineract and
>> want to contribute to the upcoming GSoC next year. Basically I am good at
>> Javascript as well as android development so what can I try? Are there any
>> suggestions?
>> Regards,
>> Inzemamul Haq
>>
>> On Sat, Jul 29, 2023 at 10:45 PM James Dailey <ja...@gmail.com>
>> wrote:
>>
>>> Thanks! It looks great.
>>>
>>> Does anyone else have suggestions?
>>> Otherwise we can proceed.
>>>
>>> A key thing about the wiki is that it is trivial to update. How does
>>> one make changes to this site? Can you walk through a change?
>>>
>>> I think we should keep our more dynamic content on the wiki. Yes?
>>>
>>>
>>>
>>> On Sat, Jul 29, 2023 at 9:15 AM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> Hi James,
>>>> I have created some changes and added `
>>>> https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract`
>>>> <https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract>
>>>> there please have a look and lemme know
>>>> regards,
>>>> Inzemam
>>>>
>>>> On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com>
>>>> wrote:
>>>>
>>>>> Opps. That was John's video.
>>>>>
>>>>> Haq - Please share your Landing Page design.... not sure how that can
>>>>> work with asciidocs / antora doing the "artifacts". But, please forward
>>>>> your ideas, share a video, explain what you've been working on. If you are
>>>>> ok with using the approach that John has outlined, a simple +1 would
>>>>> suffice.
>>>>>
>>>>> You two are free to discuss privately and bring back to the list. I
>>>>> am not able to set up a time that works for me and your timezones this week
>>>>> or next.
>>>>>
>>>>> Can you push a PR so we can see that, review it?
>>>>>
>>>>> It might be easier to put the infrastructure concept in place first
>>>>> and then make adjustments with graphical elements and artifacts.
>>>>>
>>>>>
>>>>> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> I think this is moving along nicely. Let’s see if we can’t use email
>>>>>> and/or the Apache Fineract slack to coordinate.
>>>>>>
>>>>>> Please outline your idea here John, after seeing Haqs video
>>>>>>
>>>>>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <
>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>
>>>>>>> Hey John!
>>>>>>>
>>>>>>> Yep I have created the new landing page but as previously discussed
>>>>>>> I created that in HTML/CSS/JS now if the community will agree then we can
>>>>>>> do it in Antora. I can work on that too.
>>>>>>>
>>>>>>> Also I am totally agreed with your idea as the asciidocs and the
>>>>>>> antora (based on react/node) will give a smooth flow of management.
>>>>>>> Regards,
>>>>>>> Inzemamul Haq
>>>>>>>
>>>>>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>>>>>>
>>>>>>>> Hello Inzemamul,
>>>>>>>>
>>>>>>>> I get you now. Yes, we can customize the default theme and align it
>>>>>>>> with fineract colors, theme and so on. Is this something you are willing to
>>>>>>>> do?
>>>>>>>>
>>>>>>>> Thanks
>>>>>>>>
>>>>>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <
>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> Hello John,
>>>>>>>>> What I am trying to say is that antora is based on react/node so
>>>>>>>>> we have to code the landing page in react??
>>>>>>>>>
>>>>>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io>
>>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> Hello Inzemamul,
>>>>>>>>>>
>>>>>>>>>> It's possible to generate the landing page with asciidoc and
>>>>>>>>>> antora, this is my preference but it's up to the community. Let's see what
>>>>>>>>>> the other people say.
>>>>>>>>>>
>>>>>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <
>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> Hello John!
>>>>>>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>>>>>>> the landing page with ourself using REACT am I correct?
>>>>>>>>>>> Regards,
>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> I believe there is consensus to use ascii doc as the
>>>>>>>>>>>> documentation language because of all its benefits. A lot of work has gone
>>>>>>>>>>>> into this so far, thanks to Aleks and others.
>>>>>>>>>>>>
>>>>>>>>>>>> With this in mind, I am working on putting in place the
>>>>>>>>>>>> mechanics to have the asciidoc files rendered using Antora.
>>>>>>>>>>>>
>>>>>>>>>>>> With Antora in place, the docs landing page will also be
>>>>>>>>>>>> written in asciidoc.
>>>>>>>>>>>>
>>>>>>>>>>>> Hope this helps to clarify things.
>>>>>>>>>>>>
>>>>>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> John and Inzemamul
>>>>>>>>>>>>>
>>>>>>>>>>>>> Both of you seem to be working on something related to the
>>>>>>>>>>>>> finerat website, so please be sure that your work remains aligned.
>>>>>>>>>>>>> One way to do that is to describe, here, what the steps are
>>>>>>>>>>>>> that you are doing or are about to do.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Another way is to open a ticket and self assign it to yourself
>>>>>>>>>>>>> with certain descriptions of again, things you will be working on or things
>>>>>>>>>>>>> you have already done.
>>>>>>>>>>>>> For the website, we don't strictly need a fineract jira
>>>>>>>>>>>>> ticket, but it wouldn't hurt.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Thanks,
>>>>>>>>>>>>> James
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice
>>>>>>>>>>>>>>>> for generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> I support the use of antora to generate the landing and
>>>>>>>>>>>>>>>> other pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Thanks
>>>>>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to
>>>>>>>>>>>>>>>>> tweak the changes on the site.
>>>>>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't
>>>>>>>>>>>>>>>>> show you the part but surely when I'll get my pc back will show the demo
>>>>>>>>>>>>>>>>> asap.
>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> ... is there somewhere a preview available of that new
>>>>>>>>>>>>>>>>>> stuff?
>>>>>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And
>>>>>>>>>>>>>>>>>> that it is close to being pushed ?
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to
>>>>>>>>>>>>>>>>>>>> the Github repo
>>>>>>>>>>>>>>>>>>>> "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> The documentation in HTML format under the "current"
>>>>>>>>>>>>>>>>>>>> folder is generated from the AsciiDoc (kind of a Markdown on steroids
>>>>>>>>>>>>>>>>>>>> format) files. Publishing again is a simple copy to the fineract-site repo
>>>>>>>>>>>>>>>>>>>> and pushing the udates to Github.
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a
>>>>>>>>>>>>>>>>>>>> while ago). As part of our release process we ship the current
>>>>>>>>>>>>>>>>>>>> documentation in PDF (another output format of AsciiDoc) with the
>>>>>>>>>>>>>>>>>>>> downloadable release artifacts (tar.gz files).
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the
>>>>>>>>>>>>>>>>>>>> Fineract database schema, tables, columns, relationships that are generated
>>>>>>>>>>>>>>>>>>>> by another command line tool (SchemaCrawler). I think I generated these
>>>>>>>>>>>>>>>>>>>> pages only a handful of times; at the moment not automated... and no
>>>>>>>>>>>>>>>>>>>> feedback if people find this useful or not. It would be great if they could
>>>>>>>>>>>>>>>>>>>> generate AsciiDoc instead of HTML only... then we could include this also
>>>>>>>>>>>>>>>>>>>> in the PDF documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e.
>>>>>>>>>>>>>>>>>>>> let's say we want to add "how to build"
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working
>>>>>>>>>>>>>>>>>>>>>> my way through it. Curious, how is
>>>>>>>>>>>>>>>>>>>>>> fineract.apache.org served?
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>> --
>>>>>> Sent from Gmail Mobile
>>>>>>
>>>>> --
>>> Sent from Gmail Mobile
>>>
>>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
Hello Inzemamul,
I think we agreed to use Antora to generate the documentation website from
asciidoc pages, including the landing page. Is this the customized antora
theme?
Thanks,
Ruhiu
On Sat, Jul 29, 2023 at 8:43 PM Inzemamul Haq <in...@gmail.com>
wrote:
> The wiki will be dynamic and I am working on a script which'll fetch the
> data from the wiki or confluence.
> Can someone share the links with me so I can start?
> Also James I am looking forward to working on the apache fineract and want
> to contribute to the upcoming GSoC next year. Basically I am good at
> Javascript as well as android development so what can I try? Are there any
> suggestions?
> Regards,
> Inzemamul Haq
>
> On Sat, Jul 29, 2023 at 10:45 PM James Dailey <ja...@gmail.com>
> wrote:
>
>> Thanks! It looks great.
>>
>> Does anyone else have suggestions?
>> Otherwise we can proceed.
>>
>> A key thing about the wiki is that it is trivial to update. How does one
>> make changes to this site? Can you walk through a change?
>>
>> I think we should keep our more dynamic content on the wiki. Yes?
>>
>>
>>
>> On Sat, Jul 29, 2023 at 9:15 AM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> Hi James,
>>> I have created some changes and added `
>>> https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract`
>>> <https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract>
>>> there please have a look and lemme know
>>> regards,
>>> Inzemam
>>>
>>> On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com>
>>> wrote:
>>>
>>>> Opps. That was John's video.
>>>>
>>>> Haq - Please share your Landing Page design.... not sure how that can
>>>> work with asciidocs / antora doing the "artifacts". But, please forward
>>>> your ideas, share a video, explain what you've been working on. If you are
>>>> ok with using the approach that John has outlined, a simple +1 would
>>>> suffice.
>>>>
>>>> You two are free to discuss privately and bring back to the list. I am
>>>> not able to set up a time that works for me and your timezones this week or
>>>> next.
>>>>
>>>> Can you push a PR so we can see that, review it?
>>>>
>>>> It might be easier to put the infrastructure concept in place first and
>>>> then make adjustments with graphical elements and artifacts.
>>>>
>>>>
>>>> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
>>>> wrote:
>>>>
>>>>> I think this is moving along nicely. Let’s see if we can’t use email
>>>>> and/or the Apache Fineract slack to coordinate.
>>>>>
>>>>> Please outline your idea here John, after seeing Haqs video
>>>>>
>>>>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <in...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Hey John!
>>>>>>
>>>>>> Yep I have created the new landing page but as previously discussed I
>>>>>> created that in HTML/CSS/JS now if the community will agree then we can do
>>>>>> it in Antora. I can work on that too.
>>>>>>
>>>>>> Also I am totally agreed with your idea as the asciidocs and the
>>>>>> antora (based on react/node) will give a smooth flow of management.
>>>>>> Regards,
>>>>>> Inzemamul Haq
>>>>>>
>>>>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>>>>>
>>>>>>> Hello Inzemamul,
>>>>>>>
>>>>>>> I get you now. Yes, we can customize the default theme and align it
>>>>>>> with fineract colors, theme and so on. Is this something you are willing to
>>>>>>> do?
>>>>>>>
>>>>>>> Thanks
>>>>>>>
>>>>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <
>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>
>>>>>>>> Hello John,
>>>>>>>> What I am trying to say is that antora is based on react/node so we
>>>>>>>> have to code the landing page in react??
>>>>>>>>
>>>>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>>> Hello Inzemamul,
>>>>>>>>>
>>>>>>>>> It's possible to generate the landing page with asciidoc and
>>>>>>>>> antora, this is my preference but it's up to the community. Let's see what
>>>>>>>>> the other people say.
>>>>>>>>>
>>>>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <
>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> Hello John!
>>>>>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>>>>>> the landing page with ourself using REACT am I correct?
>>>>>>>>>> Regards,
>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io>
>>>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> I believe there is consensus to use ascii doc as the
>>>>>>>>>>> documentation language because of all its benefits. A lot of work has gone
>>>>>>>>>>> into this so far, thanks to Aleks and others.
>>>>>>>>>>>
>>>>>>>>>>> With this in mind, I am working on putting in place the
>>>>>>>>>>> mechanics to have the asciidoc files rendered using Antora.
>>>>>>>>>>>
>>>>>>>>>>> With Antora in place, the docs landing page will also be written
>>>>>>>>>>> in asciidoc.
>>>>>>>>>>>
>>>>>>>>>>> Hope this helps to clarify things.
>>>>>>>>>>>
>>>>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> John and Inzemamul
>>>>>>>>>>>>
>>>>>>>>>>>> Both of you seem to be working on something related to the
>>>>>>>>>>>> finerat website, so please be sure that your work remains aligned.
>>>>>>>>>>>> One way to do that is to describe, here, what the steps are
>>>>>>>>>>>> that you are doing or are about to do.
>>>>>>>>>>>>
>>>>>>>>>>>> Another way is to open a ticket and self assign it to yourself
>>>>>>>>>>>> with certain descriptions of again, things you will be working on or things
>>>>>>>>>>>> you have already done.
>>>>>>>>>>>> For the website, we don't strictly need a fineract jira ticket,
>>>>>>>>>>>> but it wouldn't hurt.
>>>>>>>>>>>>
>>>>>>>>>>>> Thanks,
>>>>>>>>>>>> James
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> I support the use of antora to generate the landing and
>>>>>>>>>>>>>>> other pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Thanks
>>>>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to
>>>>>>>>>>>>>>>> tweak the changes on the site.
>>>>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show
>>>>>>>>>>>>>>>> you the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> ... is there somewhere a preview available of that new
>>>>>>>>>>>>>>>>> stuff?
>>>>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And
>>>>>>>>>>>>>>>>> that it is close to being pushed ?
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> The documentation in HTML format under the "current"
>>>>>>>>>>>>>>>>>>> folder is generated from the AsciiDoc (kind of a Markdown on steroids
>>>>>>>>>>>>>>>>>>> format) files. Publishing again is a simple copy to the fineract-site repo
>>>>>>>>>>>>>>>>>>> and pushing the udates to Github.
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a
>>>>>>>>>>>>>>>>>>> while ago). As part of our release process we ship the current
>>>>>>>>>>>>>>>>>>> documentation in PDF (another output format of AsciiDoc) with the
>>>>>>>>>>>>>>>>>>> downloadable release artifacts (tar.gz files).
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e.
>>>>>>>>>>>>>>>>>>> let's say we want to add "how to build"
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working
>>>>>>>>>>>>>>>>>>>>> my way through it. Curious, how is fineract.apache.org
>>>>>>>>>>>>>>>>>>>>> served?
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>
>>>>>>>>>>>>> --
>>>>> Sent from Gmail Mobile
>>>>>
>>>> --
>> Sent from Gmail Mobile
>>
>
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
The wiki will be dynamic and I am working on a script which'll fetch the
data from the wiki or confluence.
Can someone share the links with me so I can start?
Also James I am looking forward to working on the apache fineract and want
to contribute to the upcoming GSoC next year. Basically I am good at
Javascript as well as android development so what can I try? Are there any
suggestions?
Regards,
Inzemamul Haq
On Sat, Jul 29, 2023 at 10:45 PM James Dailey <ja...@gmail.com>
wrote:
> Thanks! It looks great.
>
> Does anyone else have suggestions?
> Otherwise we can proceed.
>
> A key thing about the wiki is that it is trivial to update. How does one
> make changes to this site? Can you walk through a change?
>
> I think we should keep our more dynamic content on the wiki. Yes?
>
>
>
> On Sat, Jul 29, 2023 at 9:15 AM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> Hi James,
>> I have created some changes and added `
>> https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract`
>> <https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract>
>> there please have a look and lemme know
>> regards,
>> Inzemam
>>
>> On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com>
>> wrote:
>>
>>> Opps. That was John's video.
>>>
>>> Haq - Please share your Landing Page design.... not sure how that can
>>> work with asciidocs / antora doing the "artifacts". But, please forward
>>> your ideas, share a video, explain what you've been working on. If you are
>>> ok with using the approach that John has outlined, a simple +1 would
>>> suffice.
>>>
>>> You two are free to discuss privately and bring back to the list. I am
>>> not able to set up a time that works for me and your timezones this week or
>>> next.
>>>
>>> Can you push a PR so we can see that, review it?
>>>
>>> It might be easier to put the infrastructure concept in place first and
>>> then make adjustments with graphical elements and artifacts.
>>>
>>>
>>> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
>>> wrote:
>>>
>>>> I think this is moving along nicely. Let’s see if we can’t use email
>>>> and/or the Apache Fineract slack to coordinate.
>>>>
>>>> Please outline your idea here John, after seeing Haqs video
>>>>
>>>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <in...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hey John!
>>>>>
>>>>> Yep I have created the new landing page but as previously discussed I
>>>>> created that in HTML/CSS/JS now if the community will agree then we can do
>>>>> it in Antora. I can work on that too.
>>>>>
>>>>> Also I am totally agreed with your idea as the asciidocs and the
>>>>> antora (based on react/node) will give a smooth flow of management.
>>>>> Regards,
>>>>> Inzemamul Haq
>>>>>
>>>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>>>>
>>>>>> Hello Inzemamul,
>>>>>>
>>>>>> I get you now. Yes, we can customize the default theme and align it
>>>>>> with fineract colors, theme and so on. Is this something you are willing to
>>>>>> do?
>>>>>>
>>>>>> Thanks
>>>>>>
>>>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Hello John,
>>>>>>> What I am trying to say is that antora is based on react/node so we
>>>>>>> have to code the landing page in react??
>>>>>>>
>>>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>>>
>>>>>>>> Hello Inzemamul,
>>>>>>>>
>>>>>>>> It's possible to generate the landing page with asciidoc and
>>>>>>>> antora, this is my preference but it's up to the community. Let's see what
>>>>>>>> the other people say.
>>>>>>>>
>>>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <
>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> Hello John!
>>>>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>>>>> the landing page with ourself using REACT am I correct?
>>>>>>>>> Regards,
>>>>>>>>> Inzemamul Haq
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>>>>>>
>>>>>>>>>> I believe there is consensus to use ascii doc as the
>>>>>>>>>> documentation language because of all its benefits. A lot of work has gone
>>>>>>>>>> into this so far, thanks to Aleks and others.
>>>>>>>>>>
>>>>>>>>>> With this in mind, I am working on putting in place the mechanics
>>>>>>>>>> to have the asciidoc files rendered using Antora.
>>>>>>>>>>
>>>>>>>>>> With Antora in place, the docs landing page will also be written
>>>>>>>>>> in asciidoc.
>>>>>>>>>>
>>>>>>>>>> Hope this helps to clarify things.
>>>>>>>>>>
>>>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> John and Inzemamul
>>>>>>>>>>>
>>>>>>>>>>> Both of you seem to be working on something related to the
>>>>>>>>>>> finerat website, so please be sure that your work remains aligned.
>>>>>>>>>>> One way to do that is to describe, here, what the steps are that
>>>>>>>>>>> you are doing or are about to do.
>>>>>>>>>>>
>>>>>>>>>>> Another way is to open a ticket and self assign it to yourself
>>>>>>>>>>> with certain descriptions of again, things you will be working on or things
>>>>>>>>>>> you have already done.
>>>>>>>>>>> For the website, we don't strictly need a fineract jira ticket,
>>>>>>>>>>> but it wouldn't hurt.
>>>>>>>>>>>
>>>>>>>>>>> Thanks,
>>>>>>>>>>> James
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>>>
>>>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>>> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Thanks
>>>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak
>>>>>>>>>>>>>>> the changes on the site.
>>>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show
>>>>>>>>>>>>>>> you the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> ... is there somewhere a preview available of that new
>>>>>>>>>>>>>>>> stuff?
>>>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And that
>>>>>>>>>>>>>>>> it is close to being pushed ?
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> The documentation in HTML format under the "current"
>>>>>>>>>>>>>>>>>> folder is generated from the AsciiDoc (kind of a Markdown on steroids
>>>>>>>>>>>>>>>>>> format) files. Publishing again is a simple copy to the fineract-site repo
>>>>>>>>>>>>>>>>>> and pushing the udates to Github.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e.
>>>>>>>>>>>>>>>>>> let's say we want to add "how to build"
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my
>>>>>>>>>>>>>>>>>>>> way through it. Curious, how is fineract.apache.org
>>>>>>>>>>>>>>>>>>>> served?
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>
>>>>>>>>>>>> --
>>>> Sent from Gmail Mobile
>>>>
>>> --
> Sent from Gmail Mobile
>
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
Thanks! It looks great.
Does anyone else have suggestions?
Otherwise we can proceed.
A key thing about the wiki is that it is trivial to update. How does one
make changes to this site? Can you walk through a change?
I think we should keep our more dynamic content on the wiki. Yes?
On Sat, Jul 29, 2023 at 9:15 AM Inzemamul Haq <in...@gmail.com>
wrote:
> Hi James,
> I have created some changes and added `
> https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract`
> <https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract>
> there please have a look and lemme know
> regards,
> Inzemam
>
> On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com>
> wrote:
>
>> Opps. That was John's video.
>>
>> Haq - Please share your Landing Page design.... not sure how that can
>> work with asciidocs / antora doing the "artifacts". But, please forward
>> your ideas, share a video, explain what you've been working on. If you are
>> ok with using the approach that John has outlined, a simple +1 would
>> suffice.
>>
>> You two are free to discuss privately and bring back to the list. I am
>> not able to set up a time that works for me and your timezones this week or
>> next.
>>
>> Can you push a PR so we can see that, review it?
>>
>> It might be easier to put the infrastructure concept in place first and
>> then make adjustments with graphical elements and artifacts.
>>
>>
>> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
>> wrote:
>>
>>> I think this is moving along nicely. Let’s see if we can’t use email
>>> and/or the Apache Fineract slack to coordinate.
>>>
>>> Please outline your idea here John, after seeing Haqs video
>>>
>>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> Hey John!
>>>>
>>>> Yep I have created the new landing page but as previously discussed I
>>>> created that in HTML/CSS/JS now if the community will agree then we can do
>>>> it in Antora. I can work on that too.
>>>>
>>>> Also I am totally agreed with your idea as the asciidocs and the antora
>>>> (based on react/node) will give a smooth flow of management.
>>>> Regards,
>>>> Inzemamul Haq
>>>>
>>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>>>
>>>>> Hello Inzemamul,
>>>>>
>>>>> I get you now. Yes, we can customize the default theme and align it
>>>>> with fineract colors, theme and so on. Is this something you are willing to
>>>>> do?
>>>>>
>>>>> Thanks
>>>>>
>>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Hello John,
>>>>>> What I am trying to say is that antora is based on react/node so we
>>>>>> have to code the landing page in react??
>>>>>>
>>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>>
>>>>>>> Hello Inzemamul,
>>>>>>>
>>>>>>> It's possible to generate the landing page with asciidoc and antora,
>>>>>>> this is my preference but it's up to the community. Let's see what the
>>>>>>> other people say.
>>>>>>>
>>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <
>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>
>>>>>>>> Hello John!
>>>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>>>> the landing page with ourself using REACT am I correct?
>>>>>>>> Regards,
>>>>>>>> Inzemamul Haq
>>>>>>>>
>>>>>>>>
>>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>>>>>
>>>>>>>>> I believe there is consensus to use ascii doc as the documentation
>>>>>>>>> language because of all its benefits. A lot of work has gone into this so
>>>>>>>>> far, thanks to Aleks and others.
>>>>>>>>>
>>>>>>>>> With this in mind, I am working on putting in place the mechanics
>>>>>>>>> to have the asciidoc files rendered using Antora.
>>>>>>>>>
>>>>>>>>> With Antora in place, the docs landing page will also be written
>>>>>>>>> in asciidoc.
>>>>>>>>>
>>>>>>>>> Hope this helps to clarify things.
>>>>>>>>>
>>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> John and Inzemamul
>>>>>>>>>>
>>>>>>>>>> Both of you seem to be working on something related to the
>>>>>>>>>> finerat website, so please be sure that your work remains aligned.
>>>>>>>>>> One way to do that is to describe, here, what the steps are that
>>>>>>>>>> you are doing or are about to do.
>>>>>>>>>>
>>>>>>>>>> Another way is to open a ticket and self assign it to yourself
>>>>>>>>>> with certain descriptions of again, things you will be working on or things
>>>>>>>>>> you have already done.
>>>>>>>>>> For the website, we don't strictly need a fineract jira ticket,
>>>>>>>>>> but it wouldn't hurt.
>>>>>>>>>>
>>>>>>>>>> Thanks,
>>>>>>>>>> James
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>>
>>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>>> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>>
>>>>>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Thanks
>>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak
>>>>>>>>>>>>>> the changes on the site.
>>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show
>>>>>>>>>>>>>> you the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And that
>>>>>>>>>>>>>>> it is close to being pushed ?
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> The documentation in HTML format under the "current"
>>>>>>>>>>>>>>>>> folder is generated from the AsciiDoc (kind of a Markdown on steroids
>>>>>>>>>>>>>>>>> format) files. Publishing again is a simple copy to the fineract-site repo
>>>>>>>>>>>>>>>>> and pushing the udates to Github.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e.
>>>>>>>>>>>>>>>>> let's say we want to add "how to build"
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my
>>>>>>>>>>>>>>>>>>> way through it. Curious, how is fineract.apache.org
>>>>>>>>>>>>>>>>>>> served?
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> --
>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>
>>>>>>>>>>> --
>>> Sent from Gmail Mobile
>>>
>> --
Sent from Gmail Mobile
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
Hi James,
I have created some changes and added `
https://github.com/ishqDehlvi/fineract-site/tree/redesign-fineract` there
please have a look and lemme know
regards,
Inzemam
On Tue, Jun 27, 2023 at 8:09 PM James Dailey <ja...@gmail.com> wrote:
> Opps. That was John's video.
>
> Haq - Please share your Landing Page design.... not sure how that can work
> with asciidocs / antora doing the "artifacts". But, please forward your
> ideas, share a video, explain what you've been working on. If you are ok
> with using the approach that John has outlined, a simple +1 would suffice.
>
> You two are free to discuss privately and bring back to the list. I am
> not able to set up a time that works for me and your timezones this week or
> next.
>
> Can you push a PR so we can see that, review it?
>
> It might be easier to put the infrastructure concept in place first and
> then make adjustments with graphical elements and artifacts.
>
>
> On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
> wrote:
>
>> I think this is moving along nicely. Let’s see if we can’t use email
>> and/or the Apache Fineract slack to coordinate.
>>
>> Please outline your idea here John, after seeing Haqs video
>>
>> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> Hey John!
>>>
>>> Yep I have created the new landing page but as previously discussed I
>>> created that in HTML/CSS/JS now if the community will agree then we can do
>>> it in Antora. I can work on that too.
>>>
>>> Also I am totally agreed with your idea as the asciidocs and the antora
>>> (based on react/node) will give a smooth flow of management.
>>> Regards,
>>> Inzemamul Haq
>>>
>>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>>
>>>> Hello Inzemamul,
>>>>
>>>> I get you now. Yes, we can customize the default theme and align it
>>>> with fineract colors, theme and so on. Is this something you are willing to
>>>> do?
>>>>
>>>> Thanks
>>>>
>>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hello John,
>>>>> What I am trying to say is that antora is based on react/node so we
>>>>> have to code the landing page in react??
>>>>>
>>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>
>>>>>> Hello Inzemamul,
>>>>>>
>>>>>> It's possible to generate the landing page with asciidoc and antora,
>>>>>> this is my preference but it's up to the community. Let's see what the
>>>>>> other people say.
>>>>>>
>>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Hello John!
>>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>>> the landing page with ourself using REACT am I correct?
>>>>>>> Regards,
>>>>>>> Inzemamul Haq
>>>>>>>
>>>>>>>
>>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>>>>
>>>>>>>> I believe there is consensus to use ascii doc as the documentation
>>>>>>>> language because of all its benefits. A lot of work has gone into this so
>>>>>>>> far, thanks to Aleks and others.
>>>>>>>>
>>>>>>>> With this in mind, I am working on putting in place the mechanics
>>>>>>>> to have the asciidoc files rendered using Antora.
>>>>>>>>
>>>>>>>> With Antora in place, the docs landing page will also be written in
>>>>>>>> asciidoc.
>>>>>>>>
>>>>>>>> Hope this helps to clarify things.
>>>>>>>>
>>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <
>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> John and Inzemamul
>>>>>>>>>
>>>>>>>>> Both of you seem to be working on something related to the finerat
>>>>>>>>> website, so please be sure that your work remains aligned.
>>>>>>>>> One way to do that is to describe, here, what the steps are that
>>>>>>>>> you are doing or are about to do.
>>>>>>>>>
>>>>>>>>> Another way is to open a ticket and self assign it to yourself
>>>>>>>>> with certain descriptions of again, things you will be working on or things
>>>>>>>>> you have already done.
>>>>>>>>> For the website, we don't strictly need a fineract jira ticket,
>>>>>>>>> but it wouldn't hurt.
>>>>>>>>>
>>>>>>>>> Thanks,
>>>>>>>>> James
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>>
>>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>>
>>>>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>>
>>>>>>>>>>>> Thanks
>>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>>
>>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak
>>>>>>>>>>>>> the changes on the site.
>>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show
>>>>>>>>>>>>> you the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Are you saying you are building this for Fineract? And that
>>>>>>>>>>>>>> it is close to being pushed ?
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> And as far as I have completed the landing page is on
>>>>>>>>>>>>>>> HTML,CSS and Js(whose code I'll be pushing soon as I have given my pc for
>>>>>>>>>>>>>>> repairing) where also I have used a basic javascript crawler which will
>>>>>>>>>>>>>>> crawl specially the download files from cwiki or the apache download page
>>>>>>>>>>>>>>> and will update it on the website.
>>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> The documentation in HTML format under the "current" folder
>>>>>>>>>>>>>>>> is generated from the AsciiDoc (kind of a Markdown on steroids format)
>>>>>>>>>>>>>>>> files. Publishing again is a simple copy to the fineract-site repo and
>>>>>>>>>>>>>>>> pushing the udates to Github.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Having said that: I think it would be great to have a
>>>>>>>>>>>>>>>> static site generator to manage all pages of the Fineract site. Apache
>>>>>>>>>>>>>>>> Camel is - I think - doing a great job managing their web site. It's a
>>>>>>>>>>>>>>>> combination of automatically generated pages for the documentation (also
>>>>>>>>>>>>>>>> based on AsciiDoc), they even give you access to all long term support
>>>>>>>>>>>>>>>> versions of the documentation plus the most recent one that is continually
>>>>>>>>>>>>>>>> updated from Github. Addtionally they have a landing page, a section with
>>>>>>>>>>>>>>>> blog entries and various other pages. Most of it is based on AsciiDoc...
>>>>>>>>>>>>>>>> they use then Antora (read: static site generator for AsciiDoc... more
>>>>>>>>>>>>>>>> about its capabilities here https://antora.org/) to
>>>>>>>>>>>>>>>> aggregate all of this into one coherent site. What I find really great
>>>>>>>>>>>>>>>> about this approach: every page has a Git reference; on pretty much every
>>>>>>>>>>>>>>>> page you can see a link "Edit this page"... in that way it's almost like a
>>>>>>>>>>>>>>>> Wiki or a CMS, just without the whole overhead and only based on Git.
>>>>>>>>>>>>>>>> Rebuild and publish of the site are very easy to configure e. g. with
>>>>>>>>>>>>>>>> Github actions. And of course the visual style of Antora's output can be
>>>>>>>>>>>>>>>> tweaked (https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could
>>>>>>>>>>>>>>>> you explain the process please, I do not recall.
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e. let's
>>>>>>>>>>>>>>>> say we want to add "how to build"
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my
>>>>>>>>>>>>>>>>>> way through it. Curious, how is fineract.apache.org
>>>>>>>>>>>>>>>>>> served?
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> --
>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>
>>>>>>>>>> --
>> Sent from Gmail Mobile
>>
>
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
Opps. That was John's video.
Haq - Please share your Landing Page design.... not sure how that can work
with asciidocs / antora doing the "artifacts". But, please forward your
ideas, share a video, explain what you've been working on. If you are ok
with using the approach that John has outlined, a simple +1 would suffice.
You two are free to discuss privately and bring back to the list. I am not
able to set up a time that works for me and your timezones this week or
next.
Can you push a PR so we can see that, review it?
It might be easier to put the infrastructure concept in place first and
then make adjustments with graphical elements and artifacts.
On Mon, Jun 26, 2023 at 12:16 PM James Dailey <ja...@gmail.com>
wrote:
> I think this is moving along nicely. Let’s see if we can’t use email
> and/or the Apache Fineract slack to coordinate.
>
> Please outline your idea here John, after seeing Haqs video
>
> On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> Hey John!
>>
>> Yep I have created the new landing page but as previously discussed I
>> created that in HTML/CSS/JS now if the community will agree then we can do
>> it in Antora. I can work on that too.
>>
>> Also I am totally agreed with your idea as the asciidocs and the antora
>> (based on react/node) will give a smooth flow of management.
>> Regards,
>> Inzemamul Haq
>>
>> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>>
>>> Hello Inzemamul,
>>>
>>> I get you now. Yes, we can customize the default theme and align it with
>>> fineract colors, theme and so on. Is this something you are willing to do?
>>>
>>> Thanks
>>>
>>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> Hello John,
>>>> What I am trying to say is that antora is based on react/node so we
>>>> have to code the landing page in react??
>>>>
>>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>>>
>>>>> Hello Inzemamul,
>>>>>
>>>>> It's possible to generate the landing page with asciidoc and antora,
>>>>> this is my preference but it's up to the community. Let's see what the
>>>>> other people say.
>>>>>
>>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Hello John!
>>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>>> documentation like a cms or static site generator. and we Have to create
>>>>>> the landing page with ourself using REACT am I correct?
>>>>>> Regards,
>>>>>> Inzemamul Haq
>>>>>>
>>>>>>
>>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>>>
>>>>>>> I believe there is consensus to use ascii doc as the documentation
>>>>>>> language because of all its benefits. A lot of work has gone into this so
>>>>>>> far, thanks to Aleks and others.
>>>>>>>
>>>>>>> With this in mind, I am working on putting in place the mechanics to
>>>>>>> have the asciidoc files rendered using Antora.
>>>>>>>
>>>>>>> With Antora in place, the docs landing page will also be written in
>>>>>>> asciidoc.
>>>>>>>
>>>>>>> Hope this helps to clarify things.
>>>>>>>
>>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> John and Inzemamul
>>>>>>>>
>>>>>>>> Both of you seem to be working on something related to the finerat
>>>>>>>> website, so please be sure that your work remains aligned.
>>>>>>>> One way to do that is to describe, here, what the steps are that
>>>>>>>> you are doing or are about to do.
>>>>>>>>
>>>>>>>> Another way is to open a ticket and self assign it to yourself with
>>>>>>>> certain descriptions of again, things you will be working on or things you
>>>>>>>> have already done.
>>>>>>>> For the website, we don't strictly need a fineract jira ticket, but
>>>>>>>> it wouldn't hurt.
>>>>>>>>
>>>>>>>> Thanks,
>>>>>>>> James
>>>>>>>>
>>>>>>>>
>>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>>
>>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>>
>>>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>>
>>>>>>>>>>> Thanks
>>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>>
>>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak
>>>>>>>>>>>> the changes on the site.
>>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show you
>>>>>>>>>>>> the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>>>> Regards,
>>>>>>>>>>>> Inzemam
>>>>>>>>>>>>
>>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>>
>>>>>>>>>>>>> Are you saying you are building this for Fineract? And that it
>>>>>>>>>>>>> is close to being pushed ?
>>>>>>>>>>>>>
>>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> And as far as I have completed the landing page is on HTML,CSS
>>>>>>>>>>>>>> and Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>>>>>>> will update it on the website.
>>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> The documentation in HTML format under the "current" folder
>>>>>>>>>>>>>>> is generated from the AsciiDoc (kind of a Markdown on steroids format)
>>>>>>>>>>>>>>> files. Publishing again is a simple copy to the fineract-site repo and
>>>>>>>>>>>>>>> pushing the udates to Github.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Having said that: I think it would be great to have a static
>>>>>>>>>>>>>>> site generator to manage all pages of the Fineract site. Apache Camel is -
>>>>>>>>>>>>>>> I think - doing a great job managing their web site. It's a combination of
>>>>>>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of
>>>>>>>>>>>>>>> this into one coherent site. What I find really great about this approach:
>>>>>>>>>>>>>>> every page has a Git reference; on pretty much every page you can see a
>>>>>>>>>>>>>>> link "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Where should we be updating the documentation? i.e. let's
>>>>>>>>>>>>>>> say we want to add "how to build"
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my
>>>>>>>>>>>>>>>>> way through it. Curious, how is fineract.apache.org
>>>>>>>>>>>>>>>>> served?
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>>
>>>>>>>>>>>>> --
>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>
>>>>>>>>> --
> Sent from Gmail Mobile
>
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
I think this is moving along nicely. Let’s see if we can’t use email
and/or the Apache Fineract slack to coordinate.
Please outline your idea here John, after seeing Haqs video
On Sun, Jun 25, 2023 at 11:02 PM Inzemamul Haq <in...@gmail.com>
wrote:
> Hey John!
>
> Yep I have created the new landing page but as previously discussed I
> created that in HTML/CSS/JS now if the community will agree then we can do
> it in Antora. I can work on that too.
>
> Also I am totally agreed with your idea as the asciidocs and the antora
> (based on react/node) will give a smooth flow of management.
> Regards,
> Inzemamul Haq
>
> On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
>
>> Hello Inzemamul,
>>
>> I get you now. Yes, we can customize the default theme and align it with
>> fineract colors, theme and so on. Is this something you are willing to do?
>>
>> Thanks
>>
>> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> Hello John,
>>> What I am trying to say is that antora is based on react/node so we have
>>> to code the landing page in react??
>>>
>>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>>
>>>> Hello Inzemamul,
>>>>
>>>> It's possible to generate the landing page with asciidoc and antora,
>>>> this is my preference but it's up to the community. Let's see what the
>>>> other people say.
>>>>
>>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hello John!
>>>>> What I am getting is that the ANTORA will be used to manage the
>>>>> documentation like a cms or static site generator. and we Have to create
>>>>> the landing page with ourself using REACT am I correct?
>>>>> Regards,
>>>>> Inzemamul Haq
>>>>>
>>>>>
>>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>>
>>>>>> I believe there is consensus to use ascii doc as the documentation
>>>>>> language because of all its benefits. A lot of work has gone into this so
>>>>>> far, thanks to Aleks and others.
>>>>>>
>>>>>> With this in mind, I am working on putting in place the mechanics to
>>>>>> have the asciidoc files rendered using Antora.
>>>>>>
>>>>>> With Antora in place, the docs landing page will also be written in
>>>>>> asciidoc.
>>>>>>
>>>>>> Hope this helps to clarify things.
>>>>>>
>>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> John and Inzemamul
>>>>>>>
>>>>>>> Both of you seem to be working on something related to the finerat
>>>>>>> website, so please be sure that your work remains aligned.
>>>>>>> One way to do that is to describe, here, what the steps are that you
>>>>>>> are doing or are about to do.
>>>>>>>
>>>>>>> Another way is to open a ticket and self assign it to yourself with
>>>>>>> certain descriptions of again, things you will be working on or things you
>>>>>>> have already done.
>>>>>>> For the website, we don't strictly need a fineract jira ticket, but
>>>>>>> it wouldn't hurt.
>>>>>>>
>>>>>>> Thanks,
>>>>>>> James
>>>>>>>
>>>>>>>
>>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>>>>>>
>>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>>
>>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <
>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io>
>>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>>
>>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>>
>>>>>>>>>> Thanks
>>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>>
>>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>>>>>>> changes on the site.
>>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show you
>>>>>>>>>>> the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>>> Regards,
>>>>>>>>>>> Inzemam
>>>>>>>>>>>
>>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>>
>>>>>>>>>>>> Inzemamul
>>>>>>>>>>>>
>>>>>>>>>>>> Are you saying you are building this for Fineract? And that it
>>>>>>>>>>>> is close to being pushed ?
>>>>>>>>>>>>
>>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>>
>>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> And as far as I have completed the landing page is on HTML,CSS
>>>>>>>>>>>>> and Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>>>>>> will update it on the website.
>>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I
>>>>>>>>>>>>> prefer is NEXT JS as it's most easy to manage via github). The idea of edit
>>>>>>>>>>>>> this page will require the backend so there we needed either the LAMP stack
>>>>>>>>>>>>> or the MERN/MEAN stack.
>>>>>>>>>>>>> Regards,
>>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> The documentation in HTML format under the "current" folder
>>>>>>>>>>>>>> is generated from the AsciiDoc (kind of a Markdown on steroids format)
>>>>>>>>>>>>>> files. Publishing again is a simple copy to the fineract-site repo and
>>>>>>>>>>>>>> pushing the udates to Github.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Having said that: I think it would be great to have a static
>>>>>>>>>>>>>> site generator to manage all pages of the Fineract site. Apache Camel is -
>>>>>>>>>>>>>> I think - doing a great job managing their web site. It's a combination of
>>>>>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of
>>>>>>>>>>>>>> this into one coherent site. What I find really great about this approach:
>>>>>>>>>>>>>> every page has a Git reference; on pretty much every page you can see a
>>>>>>>>>>>>>> link "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Where should we be updating the documentation? i.e. let's
>>>>>>>>>>>>>> say we want to add "how to build"
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> james
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>> --
>>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>>
>>>>>>>>>>>> --
>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>
>>>>>>>> --
Sent from Gmail Mobile
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
Hey John!
Yep I have created the new landing page but as previously discussed I
created that in HTML/CSS/JS now if the community will agree then we can do
it in Antora. I can work on that too.
Also I am totally agreed with your idea as the asciidocs and the antora
(based on react/node) will give a smooth flow of management.
Regards,
Inzemamul Haq
On Mon, 26 Jun, 2023, 10:59 am John Gathogo, <jo...@fiter.io> wrote:
> Hello Inzemamul,
>
> I get you now. Yes, we can customize the default theme and align it with
> fineract colors, theme and so on. Is this something you are willing to do?
>
> Thanks
>
> On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> Hello John,
>> What I am trying to say is that antora is based on react/node so we have
>> to code the landing page in react??
>>
>> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>>
>>> Hello Inzemamul,
>>>
>>> It's possible to generate the landing page with asciidoc and antora,
>>> this is my preference but it's up to the community. Let's see what the
>>> other people say.
>>>
>>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> Hello John!
>>>> What I am getting is that the ANTORA will be used to manage the
>>>> documentation like a cms or static site generator. and we Have to create
>>>> the landing page with ourself using REACT am I correct?
>>>> Regards,
>>>> Inzemamul Haq
>>>>
>>>>
>>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>>
>>>>> I believe there is consensus to use ascii doc as the documentation
>>>>> language because of all its benefits. A lot of work has gone into this so
>>>>> far, thanks to Aleks and others.
>>>>>
>>>>> With this in mind, I am working on putting in place the mechanics to
>>>>> have the asciidoc files rendered using Antora.
>>>>>
>>>>> With Antora in place, the docs landing page will also be written in
>>>>> asciidoc.
>>>>>
>>>>> Hope this helps to clarify things.
>>>>>
>>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> John and Inzemamul
>>>>>>
>>>>>> Both of you seem to be working on something related to the finerat
>>>>>> website, so please be sure that your work remains aligned.
>>>>>> One way to do that is to describe, here, what the steps are that you
>>>>>> are doing or are about to do.
>>>>>>
>>>>>> Another way is to open a ticket and self assign it to yourself with
>>>>>> certain descriptions of again, things you will be working on or things you
>>>>>> have already done.
>>>>>> For the website, we don't strictly need a fineract jira ticket, but
>>>>>> it wouldn't hurt.
>>>>>>
>>>>>> Thanks,
>>>>>> James
>>>>>>
>>>>>>
>>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>>>>>
>>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>>
>>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> John Are you volunteering to implement this?
>>>>>>>>
>>>>>>>>
>>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>>>>
>>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>>
>>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>>
>>>>>>>>> Thanks
>>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>>
>>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>>>>>> changes on the site.
>>>>>>>>>> Sorry but my pc is there for repair that's why I can't show you
>>>>>>>>>> the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>>> Regards,
>>>>>>>>>> Inzemam
>>>>>>>>>>
>>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>>
>>>>>>>>>>> Inzemamul
>>>>>>>>>>>
>>>>>>>>>>> Are you saying you are building this for Fineract? And that it
>>>>>>>>>>> is close to being pushed ?
>>>>>>>>>>>
>>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>>
>>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> And as far as I have completed the landing page is on HTML,CSS
>>>>>>>>>>>> and Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>>>>> will update it on the website.
>>>>>>>>>>>> For a CMS we have to work on REACT based project (what I prefer
>>>>>>>>>>>> is NEXT JS as it's most easy to manage via github). The idea of edit this
>>>>>>>>>>>> page will require the backend so there we needed either the LAMP stack or
>>>>>>>>>>>> the MERN/MEAN stack.
>>>>>>>>>>>> Regards,
>>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>>
>>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> ... the process is quite simple: anything we push to the
>>>>>>>>>>>>> Github repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch
>>>>>>>>>>>>> "asf-site" will be picked up automatically (I believe) by Apache
>>>>>>>>>>>>> Infrastructure (probably via a simple Git pull) to publish them on the
>>>>>>>>>>>>> Apache domain (in our case fineract.apache.org).
>>>>>>>>>>>>>
>>>>>>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>>>>>>> udates to Github.
>>>>>>>>>>>>>
>>>>>>>>>>>>> At the moment I do this manually (last update was a while
>>>>>>>>>>>>> ago). As part of our release process we ship the current documentation in
>>>>>>>>>>>>> PDF (another output format of AsciiDoc) with the downloadable release
>>>>>>>>>>>>> artifacts (tar.gz files).
>>>>>>>>>>>>>
>>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> Having said that: I think it would be great to have a static
>>>>>>>>>>>>> site generator to manage all pages of the Fineract site. Apache Camel is -
>>>>>>>>>>>>> I think - doing a great job managing their web site. It's a combination of
>>>>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of
>>>>>>>>>>>>> this into one coherent site. What I find really great about this approach:
>>>>>>>>>>>>> every page has a Git reference; on pretty much every page you can see a
>>>>>>>>>>>>> link "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> Cheers
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>>
>>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>>
>>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>>
>>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>>>>
>>>>>>>>>>>>> Where should we be updating the documentation? i.e. let's
>>>>>>>>>>>>> say we want to add "how to build"
>>>>>>>>>>>>>
>>>>>>>>>>>>> james
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> why?
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>>> and
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>> --
>>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>>
>>>>>>>>>>> --
>>>>>>>> Sent from Gmail Mobile
>>>>>>>>
>>>>>>>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
Hello Inzemamul,
I get you now. Yes, we can customize the default theme and align it with
fineract colors, theme and so on. Is this something you are willing to do?
Thanks
On Sat, Jun 24, 2023 at 7:48 PM Inzemamul Haq <in...@gmail.com>
wrote:
> Hello John,
> What I am trying to say is that antora is based on react/node so we have
> to code the landing page in react??
>
> On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
>
>> Hello Inzemamul,
>>
>> It's possible to generate the landing page with asciidoc and antora, this
>> is my preference but it's up to the community. Let's see what the other
>> people say.
>>
>> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> Hello John!
>>> What I am getting is that the ANTORA will be used to manage the
>>> documentation like a cms or static site generator. and we Have to create
>>> the landing page with ourself using REACT am I correct?
>>> Regards,
>>> Inzemamul Haq
>>>
>>>
>>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>>
>>>> I believe there is consensus to use ascii doc as the documentation
>>>> language because of all its benefits. A lot of work has gone into this so
>>>> far, thanks to Aleks and others.
>>>>
>>>> With this in mind, I am working on putting in place the mechanics to
>>>> have the asciidoc files rendered using Antora.
>>>>
>>>> With Antora in place, the docs landing page will also be written in
>>>> asciidoc.
>>>>
>>>> Hope this helps to clarify things.
>>>>
>>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>>>> wrote:
>>>>
>>>>> John and Inzemamul
>>>>>
>>>>> Both of you seem to be working on something related to the finerat
>>>>> website, so please be sure that your work remains aligned.
>>>>> One way to do that is to describe, here, what the steps are that you
>>>>> are doing or are about to do.
>>>>>
>>>>> Another way is to open a ticket and self assign it to yourself with
>>>>> certain descriptions of again, things you will be working on or things you
>>>>> have already done.
>>>>> For the website, we don't strictly need a fineract jira ticket, but it
>>>>> wouldn't hurt.
>>>>>
>>>>> Thanks,
>>>>> James
>>>>>
>>>>>
>>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>>>>
>>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>>
>>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> John Are you volunteering to implement this?
>>>>>>>
>>>>>>>
>>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>>>
>>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>>> generating docs from multiple sources and so on.
>>>>>>>>
>>>>>>>> I support the use of antora to generate the landing and other
>>>>>>>> pages. See attached video demonstrating the capabilities of antora.
>>>>>>>>
>>>>>>>> Thanks
>>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>>
>>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>>>>> changes on the site.
>>>>>>>>> Sorry but my pc is there for repair that's why I can't show you
>>>>>>>>> the part but surely when I'll get my pc back will show the demo asap.
>>>>>>>>> Regards,
>>>>>>>>> Inzemam
>>>>>>>>>
>>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>
>>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>>
>>>>>>>>>> Inzemamul
>>>>>>>>>>
>>>>>>>>>> Are you saying you are building this for Fineract? And that it is
>>>>>>>>>> close to being pushed ?
>>>>>>>>>>
>>>>>>>>>> maybe others have questions about this?
>>>>>>>>>>
>>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> And as far as I have completed the landing page is on HTML,CSS
>>>>>>>>>>> and Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>>>> will update it on the website.
>>>>>>>>>>> For a CMS we have to work on REACT based project (what I prefer
>>>>>>>>>>> is NEXT JS as it's most easy to manage via github). The idea of edit this
>>>>>>>>>>> page will require the backend so there we needed either the LAMP stack or
>>>>>>>>>>> the MERN/MEAN stack.
>>>>>>>>>>> Regards,
>>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>>
>>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> ... the process is quite simple: anything we push to the Github
>>>>>>>>>>>> repo "https://github.com/apache/fineract-site"
>>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site"
>>>>>>>>>>>> will be picked up automatically (I believe) by Apache Infrastructure
>>>>>>>>>>>> (probably via a simple Git pull) to publish them on the Apache domain (in
>>>>>>>>>>>> our case fineract.apache.org).
>>>>>>>>>>>>
>>>>>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>>>>>> udates to Github.
>>>>>>>>>>>>
>>>>>>>>>>>> At the moment I do this manually (last update was a while ago).
>>>>>>>>>>>> As part of our release process we ship the current documentation in PDF
>>>>>>>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>>>>>>>> (tar.gz files).
>>>>>>>>>>>>
>>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> Having said that: I think it would be great to have a static
>>>>>>>>>>>> site generator to manage all pages of the Fineract site. Apache Camel is -
>>>>>>>>>>>> I think - doing a great job managing their web site. It's a combination of
>>>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of
>>>>>>>>>>>> this into one coherent site. What I find really great about this approach:
>>>>>>>>>>>> every page has a Git reference; on pretty much every page you can see a
>>>>>>>>>>>> link "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> Cheers
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>>
>>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>>
>>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>>
>>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>>
>>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>>>
>>>>>>>>>>>> Where should we be updating the documentation? i.e. let's say
>>>>>>>>>>>> we want to add "how to build"
>>>>>>>>>>>>
>>>>>>>>>>>> james
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>>
>>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>>
>>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>>
>>>>>>>>>>>>> why?
>>>>>>>>>>>>>
>>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>>> improvements.
>>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>>> and
>>>>>>>>>>>>>
>>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>>
>>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>>>>
>>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>
>>>>>>>>>>>>>>> --
>>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>>
>>>>>>>>>> --
>>>>>>> Sent from Gmail Mobile
>>>>>>>
>>>>>>
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
Hello John,
What I am trying to say is that antora is based on react/node so we have to
code the landing page in react??
On Fri, Jun 23, 2023 at 10:49 AM John Gathogo <jo...@fiter.io> wrote:
> Hello Inzemamul,
>
> It's possible to generate the landing page with asciidoc and antora, this
> is my preference but it's up to the community. Let's see what the other
> people say.
>
> On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> Hello John!
>> What I am getting is that the ANTORA will be used to manage the
>> documentation like a cms or static site generator. and we Have to create
>> the landing page with ourself using REACT am I correct?
>> Regards,
>> Inzemamul Haq
>>
>>
>> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>>
>>> I believe there is consensus to use ascii doc as the documentation
>>> language because of all its benefits. A lot of work has gone into this so
>>> far, thanks to Aleks and others.
>>>
>>> With this in mind, I am working on putting in place the mechanics to
>>> have the asciidoc files rendered using Antora.
>>>
>>> With Antora in place, the docs landing page will also be written in
>>> asciidoc.
>>>
>>> Hope this helps to clarify things.
>>>
>>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>>> wrote:
>>>
>>>> John and Inzemamul
>>>>
>>>> Both of you seem to be working on something related to the finerat
>>>> website, so please be sure that your work remains aligned.
>>>> One way to do that is to describe, here, what the steps are that you
>>>> are doing or are about to do.
>>>>
>>>> Another way is to open a ticket and self assign it to yourself with
>>>> certain descriptions of again, things you will be working on or things you
>>>> have already done.
>>>> For the website, we don't strictly need a fineract jira ticket, but it
>>>> wouldn't hurt.
>>>>
>>>> Thanks,
>>>> James
>>>>
>>>>
>>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>>>
>>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>>
>>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> John Are you volunteering to implement this?
>>>>>>
>>>>>>
>>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>>
>>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>>> generating docs from multiple sources and so on.
>>>>>>>
>>>>>>> I support the use of antora to generate the landing and other pages.
>>>>>>> See attached video demonstrating the capabilities of antora.
>>>>>>>
>>>>>>> Thanks
>>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>>
>>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <
>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>
>>>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>>>> changes on the site.
>>>>>>>> Sorry but my pc is there for repair that's why I can't show you the
>>>>>>>> part but surely when I'll get my pc back will show the demo asap.
>>>>>>>> Regards,
>>>>>>>> Inzemam
>>>>>>>>
>>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>
>>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>>
>>>>>>>>> Inzemamul
>>>>>>>>>
>>>>>>>>> Are you saying you are building this for Fineract? And that it is
>>>>>>>>> close to being pushed ?
>>>>>>>>>
>>>>>>>>> maybe others have questions about this?
>>>>>>>>>
>>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>>
>>>>>>>>>
>>>>>>>>> And as far as I have completed the landing page is on HTML,CSS and
>>>>>>>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>>> will update it on the website.
>>>>>>>>>> For a CMS we have to work on REACT based project (what I prefer
>>>>>>>>>> is NEXT JS as it's most easy to manage via github). The idea of edit this
>>>>>>>>>> page will require the backend so there we needed either the LAMP stack or
>>>>>>>>>> the MERN/MEAN stack.
>>>>>>>>>> Regards,
>>>>>>>>>> Inzemamul Haq
>>>>>>>>>>
>>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> ... the process is quite simple: anything we push to the Github
>>>>>>>>>>> repo "https://github.com/apache/fineract-site"
>>>>>>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site"
>>>>>>>>>>> will be picked up automatically (I believe) by Apache Infrastructure
>>>>>>>>>>> (probably via a simple Git pull) to publish them on the Apache domain (in
>>>>>>>>>>> our case fineract.apache.org).
>>>>>>>>>>>
>>>>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>>>>> udates to Github.
>>>>>>>>>>>
>>>>>>>>>>> At the moment I do this manually (last update was a while ago).
>>>>>>>>>>> As part of our release process we ship the current documentation in PDF
>>>>>>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>>>>>>> (tar.gz files).
>>>>>>>>>>>
>>>>>>>>>>> Note: there another set of HTML pages about the Fineract
>>>>>>>>>>> database schema, tables, columns, relationships that are generated by
>>>>>>>>>>> another command line tool (SchemaCrawler). I think I generated these pages
>>>>>>>>>>> only a handful of times; at the moment not automated... and no feedback if
>>>>>>>>>>> people find this useful or not. It would be great if they could generate
>>>>>>>>>>> AsciiDoc instead of HTML only... then we could include this also in the PDF
>>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> Having said that: I think it would be great to have a static
>>>>>>>>>>> site generator to manage all pages of the Fineract site. Apache Camel is -
>>>>>>>>>>> I think - doing a great job managing their web site. It's a combination of
>>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of this
>>>>>>>>>>> into one coherent site. What I find really great about this approach: every
>>>>>>>>>>> page has a Git reference; on pretty much every page you can see a link
>>>>>>>>>>> "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> Cheers
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>>
>>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>>
>>>>>>>>>>> That is generated at release time.
>>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>>
>>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>>
>>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>>
>>>>>>>>>>> Where should we be updating the documentation? i.e. let's say
>>>>>>>>>>> we want to add "how to build"
>>>>>>>>>>>
>>>>>>>>>>> james
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>>
>>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>>
>>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>>
>>>>>>>>>>>> why?
>>>>>>>>>>>>
>>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>>> improvements.
>>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>>> and
>>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <
>>>>>>>>>>>> chtompki@gmail.com> wrote:
>>>>>>>>>>>>
>>>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>>>
>>>>>>>>>>>>> -Rob
>>>>>>>>>>>>>
>>>>>>>>>>>>>
>>>>>>>>>>>>>> --
>>>>>>>>> Sent from Gmail Mobile
>>>>>>>>>
>>>>>>>>> --
>>>>>> Sent from Gmail Mobile
>>>>>>
>>>>>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
Hello Inzemamul,
It's possible to generate the landing page with asciidoc and antora, this
is my preference but it's up to the community. Let's see what the other
people say.
On Thu, Jun 22, 2023 at 4:24 PM Inzemamul Haq <in...@gmail.com>
wrote:
> Hello John!
> What I am getting is that the ANTORA will be used to manage the
> documentation like a cms or static site generator. and we Have to create
> the landing page with ourself using REACT am I correct?
> Regards,
> Inzemamul Haq
>
>
> On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
>
>> I believe there is consensus to use ascii doc as the documentation
>> language because of all its benefits. A lot of work has gone into this so
>> far, thanks to Aleks and others.
>>
>> With this in mind, I am working on putting in place the mechanics to have
>> the asciidoc files rendered using Antora.
>>
>> With Antora in place, the docs landing page will also be written in
>> asciidoc.
>>
>> Hope this helps to clarify things.
>>
>> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
>> wrote:
>>
>>> John and Inzemamul
>>>
>>> Both of you seem to be working on something related to the finerat
>>> website, so please be sure that your work remains aligned.
>>> One way to do that is to describe, here, what the steps are that you are
>>> doing or are about to do.
>>>
>>> Another way is to open a ticket and self assign it to yourself with
>>> certain descriptions of again, things you will be working on or things you
>>> have already done.
>>> For the website, we don't strictly need a fineract jira ticket, but it
>>> wouldn't hurt.
>>>
>>> Thanks,
>>> James
>>>
>>>
>>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>>
>>>> @James Dailey <ja...@gmail.com> Yes.
>>>>
>>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>>>> wrote:
>>>>
>>>>> John Are you volunteering to implement this?
>>>>>
>>>>>
>>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>>>
>>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>>> generating docs from multiple sources and so on.
>>>>>>
>>>>>> I support the use of antora to generate the landing and other pages.
>>>>>> See attached video demonstrating the capabilities of antora.
>>>>>>
>>>>>> Thanks
>>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>>
>>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>>> changes on the site.
>>>>>>> Sorry but my pc is there for repair that's why I can't show you the
>>>>>>> part but surely when I'll get my pc back will show the demo asap.
>>>>>>> Regards,
>>>>>>> Inzemam
>>>>>>>
>>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>
>>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>>
>>>>>>>> Inzemamul
>>>>>>>>
>>>>>>>> Are you saying you are building this for Fineract? And that it is
>>>>>>>> close to being pushed ?
>>>>>>>>
>>>>>>>> maybe others have questions about this?
>>>>>>>>
>>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>>
>>>>>>>>
>>>>>>>> And as far as I have completed the landing page is on HTML,CSS and
>>>>>>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>>> will update it on the website.
>>>>>>>>> For a CMS we have to work on REACT based project (what I prefer is
>>>>>>>>> NEXT JS as it's most easy to manage via github). The idea of edit this page
>>>>>>>>> will require the backend so there we needed either the LAMP stack or the
>>>>>>>>> MERN/MEAN stack.
>>>>>>>>> Regards,
>>>>>>>>> Inzemamul Haq
>>>>>>>>>
>>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>>
>>>>>>>>>> ... the process is quite simple: anything we push to the Github
>>>>>>>>>> repo "https://github.com/apache/fineract-site"
>>>>>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site"
>>>>>>>>>> will be picked up automatically (I believe) by Apache Infrastructure
>>>>>>>>>> (probably via a simple Git pull) to publish them on the Apache domain (in
>>>>>>>>>> our case fineract.apache.org).
>>>>>>>>>>
>>>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>>>> udates to Github.
>>>>>>>>>>
>>>>>>>>>> At the moment I do this manually (last update was a while ago).
>>>>>>>>>> As part of our release process we ship the current documentation in PDF
>>>>>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>>>>>> (tar.gz files).
>>>>>>>>>>
>>>>>>>>>> Note: there another set of HTML pages about the Fineract database
>>>>>>>>>> schema, tables, columns, relationships that are generated by another
>>>>>>>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>>>>>>>> handful of times; at the moment not automated... and no feedback if people
>>>>>>>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>>>>>>>> instead of HTML only... then we could include this also in the PDF
>>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> Having said that: I think it would be great to have a static site
>>>>>>>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>>>>>>>> think - doing a great job managing their web site. It's a combination of
>>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>>> capabilities here https://antora.org/) to aggregate all of this
>>>>>>>>>> into one coherent site. What I find really great about this approach: every
>>>>>>>>>> page has a Git reference; on pretty much every page you can see a link
>>>>>>>>>> "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> Cheers
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>>
>>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>>
>>>>>>>>>> That is generated at release time.
>>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>>
>>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>>
>>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>>
>>>>>>>>>> Where should we be updating the documentation? i.e. let's say
>>>>>>>>>> we want to add "how to build"
>>>>>>>>>>
>>>>>>>>>> james
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>>
>>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>>
>>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>>
>>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>>
>>>>>>>>>>> why?
>>>>>>>>>>>
>>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>>> improvements.
>>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>>> and
>>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>>>>>>>> wrote:
>>>>>>>>>>>
>>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>>
>>>>>>>>>>>> -Rob
>>>>>>>>>>>>
>>>>>>>>>>>>
>>>>>>>>>>>>> --
>>>>>>>> Sent from Gmail Mobile
>>>>>>>>
>>>>>>>> --
>>>>> Sent from Gmail Mobile
>>>>>
>>>>
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
Hello John!
What I am getting is that the ANTORA will be used to manage the
documentation like a cms or static site generator. and we Have to create
the landing page with ourself using REACT am I correct?
Regards,
Inzemamul Haq
On Wed, 21 Jun, 2023, 7:52 pm John Gathogo, <jo...@fiter.io> wrote:
> I believe there is consensus to use ascii doc as the documentation
> language because of all its benefits. A lot of work has gone into this so
> far, thanks to Aleks and others.
>
> With this in mind, I am working on putting in place the mechanics to have
> the asciidoc files rendered using Antora.
>
> With Antora in place, the docs landing page will also be written in
> asciidoc.
>
> Hope this helps to clarify things.
>
> On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com>
> wrote:
>
>> John and Inzemamul
>>
>> Both of you seem to be working on something related to the finerat
>> website, so please be sure that your work remains aligned.
>> One way to do that is to describe, here, what the steps are that you are
>> doing or are about to do.
>>
>> Another way is to open a ticket and self assign it to yourself with
>> certain descriptions of again, things you will be working on or things you
>> have already done.
>> For the website, we don't strictly need a fineract jira ticket, but it
>> wouldn't hurt.
>>
>> Thanks,
>> James
>>
>>
>> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>>
>>> @James Dailey <ja...@gmail.com> Yes.
>>>
>>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>>> wrote:
>>>
>>>> John Are you volunteering to implement this?
>>>>
>>>>
>>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>>
>>>>> Since we are using ascii doc, antora is a natural choice for
>>>>> generating/publishing the doc as it allows for things like versioning,
>>>>> generating docs from multiple sources and so on.
>>>>>
>>>>> I support the use of antora to generate the landing and other pages.
>>>>> See attached video demonstrating the capabilities of antora.
>>>>>
>>>>> Thanks
>>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>>
>>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>>> changes on the site.
>>>>>> Sorry but my pc is there for repair that's why I can't show you the
>>>>>> part but surely when I'll get my pc back will show the demo asap.
>>>>>> Regards,
>>>>>> Inzemam
>>>>>>
>>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>
>>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>>
>>>>>>> Inzemamul
>>>>>>>
>>>>>>> Are you saying you are building this for Fineract? And that it is
>>>>>>> close to being pushed ?
>>>>>>>
>>>>>>> maybe others have questions about this?
>>>>>>>
>>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <
>>>>>>> inzemamhaq05@gmail.com> wrote:
>>>>>>>
>>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>>
>>>>>>>
>>>>>>> And as far as I have completed the landing page is on HTML,CSS and
>>>>>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>>> will update it on the website.
>>>>>>>> For a CMS we have to work on REACT based project (what I prefer is
>>>>>>>> NEXT JS as it's most easy to manage via github). The idea of edit this page
>>>>>>>> will require the backend so there we needed either the LAMP stack or the
>>>>>>>> MERN/MEAN stack.
>>>>>>>> Regards,
>>>>>>>> Inzemamul Haq
>>>>>>>>
>>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>>
>>>>>>>>> ... the process is quite simple: anything we push to the Github
>>>>>>>>> repo "https://github.com/apache/fineract-site"
>>>>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site"
>>>>>>>>> will be picked up automatically (I believe) by Apache Infrastructure
>>>>>>>>> (probably via a simple Git pull) to publish them on the Apache domain (in
>>>>>>>>> our case fineract.apache.org).
>>>>>>>>>
>>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>>> udates to Github.
>>>>>>>>>
>>>>>>>>> At the moment I do this manually (last update was a while ago). As
>>>>>>>>> part of our release process we ship the current documentation in PDF
>>>>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>>>>> (tar.gz files).
>>>>>>>>>
>>>>>>>>> Note: there another set of HTML pages about the Fineract database
>>>>>>>>> schema, tables, columns, relationships that are generated by another
>>>>>>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>>>>>>> handful of times; at the moment not automated... and no feedback if people
>>>>>>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>>>>>>> instead of HTML only... then we could include this also in the PDF
>>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> Having said that: I think it would be great to have a static site
>>>>>>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>>>>>>> think - doing a great job managing their web site. It's a combination of
>>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>>> capabilities here https://antora.org/) to aggregate all of this
>>>>>>>>> into one coherent site. What I find really great about this approach: every
>>>>>>>>> page has a Git reference; on pretty much every page you can see a link
>>>>>>>>> "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> Cheers
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>>
>>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>>
>>>>>>>>> That is generated at release time.
>>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>>
>>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>>
>>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>>> explain the process please, I do not recall.
>>>>>>>>>
>>>>>>>>> Where should we be updating the documentation? i.e. let's say we
>>>>>>>>> want to add "how to build"
>>>>>>>>>
>>>>>>>>> james
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>>
>>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>>
>>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>>
>>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>>
>>>>>>>>>> why?
>>>>>>>>>>
>>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>>> improvements.
>>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>>> and
>>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>>>>>>> wrote:
>>>>>>>>>>
>>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>>
>>>>>>>>>>> -Rob
>>>>>>>>>>>
>>>>>>>>>>>
>>>>>>>>>>>> --
>>>>>>> Sent from Gmail Mobile
>>>>>>>
>>>>>>> --
>>>> Sent from Gmail Mobile
>>>>
>>>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
I believe there is consensus to use ascii doc as the documentation language
because of all its benefits. A lot of work has gone into this so far,
thanks to Aleks and others.
With this in mind, I am working on putting in place the mechanics to have
the asciidoc files rendered using Antora.
With Antora in place, the docs landing page will also be written in
asciidoc.
Hope this helps to clarify things.
On Wed, Jun 21, 2023 at 4:48 PM James Dailey <ja...@gmail.com> wrote:
> John and Inzemamul
>
> Both of you seem to be working on something related to the finerat
> website, so please be sure that your work remains aligned.
> One way to do that is to describe, here, what the steps are that you are
> doing or are about to do.
>
> Another way is to open a ticket and self assign it to yourself with
> certain descriptions of again, things you will be working on or things you
> have already done.
> For the website, we don't strictly need a fineract jira ticket, but it
> wouldn't hurt.
>
> Thanks,
> James
>
>
> On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
>
>> @James Dailey <ja...@gmail.com> Yes.
>>
>> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
>> wrote:
>>
>>> John Are you volunteering to implement this?
>>>
>>>
>>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>>
>>>> Since we are using ascii doc, antora is a natural choice for
>>>> generating/publishing the doc as it allows for things like versioning,
>>>> generating docs from multiple sources and so on.
>>>>
>>>> I support the use of antora to generate the landing and other pages.
>>>> See attached video demonstrating the capabilities of antora.
>>>>
>>>> Thanks
>>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>>
>>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
>>>> wrote:
>>>>
>>>>> Yes I am working on it to automate and make it easy to tweak the
>>>>> changes on the site.
>>>>> Sorry but my pc is there for repair that's why I can't show you the
>>>>> part but surely when I'll get my pc back will show the demo asap.
>>>>> Regards,
>>>>> Inzemam
>>>>>
>>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>>> cheetah@monkeysintown.com> wrote:
>>>>>
>>>>>> ... is there somewhere a preview available of that new stuff?
>>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>>
>>>>>> Inzemamul
>>>>>>
>>>>>> Are you saying you are building this for Fineract? And that it is
>>>>>> close to being pushed ?
>>>>>>
>>>>>> maybe others have questions about this?
>>>>>>
>>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> What they have done is that they are based on ReactJs.
>>>>>>>
>>>>>>
>>>>>> And as far as I have completed the landing page is on HTML,CSS and
>>>>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>>> specially the download files from cwiki or the apache download page and
>>>>>>> will update it on the website.
>>>>>>> For a CMS we have to work on REACT based project (what I prefer is
>>>>>>> NEXT JS as it's most easy to manage via github). The idea of edit this page
>>>>>>> will require the backend so there we needed either the LAMP stack or the
>>>>>>> MERN/MEAN stack.
>>>>>>> Regards,
>>>>>>> Inzemamul Haq
>>>>>>>
>>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>>
>>>>>>>> ... the process is quite simple: anything we push to the Github
>>>>>>>> repo "https://github.com/apache/fineract-site"
>>>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site"
>>>>>>>> will be picked up automatically (I believe) by Apache Infrastructure
>>>>>>>> (probably via a simple Git pull) to publish them on the Apache domain (in
>>>>>>>> our case fineract.apache.org).
>>>>>>>>
>>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>>> udates to Github.
>>>>>>>>
>>>>>>>> At the moment I do this manually (last update was a while ago). As
>>>>>>>> part of our release process we ship the current documentation in PDF
>>>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>>>> (tar.gz files).
>>>>>>>>
>>>>>>>> Note: there another set of HTML pages about the Fineract database
>>>>>>>> schema, tables, columns, relationships that are generated by another
>>>>>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>>>>>> handful of times; at the moment not automated... and no feedback if people
>>>>>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>>>>>> instead of HTML only... then we could include this also in the PDF
>>>>>>>> documentation; but for now it is what it is.
>>>>>>>>
>>>>>>>>
>>>>>>>> Having said that: I think it would be great to have a static site
>>>>>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>>>>>> think - doing a great job managing their web site. It's a combination of
>>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>>> capabilities here https://antora.org/) to aggregate all of this
>>>>>>>> into one coherent site. What I find really great about this approach: every
>>>>>>>> page has a Git reference; on pretty much every page you can see a link
>>>>>>>> "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>>
>>>>>>>>
>>>>>>>> Cheers
>>>>>>>>
>>>>>>>>
>>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>>
>>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>>
>>>>>>>> That is generated at release time.
>>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>>
>>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>>
>>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you
>>>>>>>> explain the process please, I do not recall.
>>>>>>>>
>>>>>>>> Where should we be updating the documentation? i.e. let's say we
>>>>>>>> want to add "how to build"
>>>>>>>>
>>>>>>>> james
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>>
>>>>>>>>> repo:apache/fineract-site
>>>>>>>>>
>>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>>
>>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>>
>>>>>>>>> why?
>>>>>>>>>
>>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>>> improvements.
>>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>>> and
>>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>>>>>> wrote:
>>>>>>>>>
>>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>>
>>>>>>>>>> -Rob
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>> --
>>>>>> Sent from Gmail Mobile
>>>>>>
>>>>>> --
>>> Sent from Gmail Mobile
>>>
>>
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
John and Inzemamul
Both of you seem to be working on something related to the finerat website,
so please be sure that your work remains aligned.
One way to do that is to describe, here, what the steps are that you are
doing or are about to do.
Another way is to open a ticket and self assign it to yourself with certain
descriptions of again, things you will be working on or things you have
already done.
For the website, we don't strictly need a fineract jira ticket, but it
wouldn't hurt.
Thanks,
James
On Tue, Jun 20, 2023 at 10:30 PM John Gathogo <jo...@fiter.io> wrote:
> @James Dailey <ja...@gmail.com> Yes.
>
> On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com>
> wrote:
>
>> John Are you volunteering to implement this?
>>
>>
>> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>>
>>> Since we are using ascii doc, antora is a natural choice for
>>> generating/publishing the doc as it allows for things like versioning,
>>> generating docs from multiple sources and so on.
>>>
>>> I support the use of antora to generate the landing and other pages. See
>>> attached video demonstrating the capabilities of antora.
>>>
>>> Thanks
>>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>>
>>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> Yes I am working on it to automate and make it easy to tweak the
>>>> changes on the site.
>>>> Sorry but my pc is there for repair that's why I can't show you the
>>>> part but surely when I'll get my pc back will show the demo asap.
>>>> Regards,
>>>> Inzemam
>>>>
>>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>>> cheetah@monkeysintown.com> wrote:
>>>>
>>>>> ... is there somewhere a preview available of that new stuff?
>>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>>
>>>>> Inzemamul
>>>>>
>>>>> Are you saying you are building this for Fineract? And that it is
>>>>> close to being pushed ?
>>>>>
>>>>> maybe others have questions about this?
>>>>>
>>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> What they have done is that they are based on ReactJs.
>>>>>>
>>>>>
>>>>> And as far as I have completed the landing page is on HTML,CSS and
>>>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>>> where also I have used a basic javascript crawler which will crawl
>>>>>> specially the download files from cwiki or the apache download page and
>>>>>> will update it on the website.
>>>>>> For a CMS we have to work on REACT based project (what I prefer is
>>>>>> NEXT JS as it's most easy to manage via github). The idea of edit this page
>>>>>> will require the backend so there we needed either the LAMP stack or the
>>>>>> MERN/MEAN stack.
>>>>>> Regards,
>>>>>> Inzemamul Haq
>>>>>>
>>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>>> cheetah@monkeysintown.com> wrote:
>>>>>>
>>>>>>> ... the process is quite simple: anything we push to the Github repo
>>>>>>> "https://github.com/apache/fineract-site"
>>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site" will
>>>>>>> be picked up automatically (I believe) by Apache Infrastructure (probably
>>>>>>> via a simple Git pull) to publish them on the Apache domain (in our case
>>>>>>> fineract.apache.org).
>>>>>>>
>>>>>>> The documentation in HTML format under the "current" folder is
>>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>>> udates to Github.
>>>>>>>
>>>>>>> At the moment I do this manually (last update was a while ago). As
>>>>>>> part of our release process we ship the current documentation in PDF
>>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>>> (tar.gz files).
>>>>>>>
>>>>>>> Note: there another set of HTML pages about the Fineract database
>>>>>>> schema, tables, columns, relationships that are generated by another
>>>>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>>>>> handful of times; at the moment not automated... and no feedback if people
>>>>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>>>>> instead of HTML only... then we could include this also in the PDF
>>>>>>> documentation; but for now it is what it is.
>>>>>>>
>>>>>>>
>>>>>>> Having said that: I think it would be great to have a static site
>>>>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>>>>> think - doing a great job managing their web site. It's a combination of
>>>>>>> automatically generated pages for the documentation (also based on
>>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>>> capabilities here https://antora.org/) to aggregate all of this
>>>>>>> into one coherent site. What I find really great about this approach: every
>>>>>>> page has a Git reference; on pretty much every page you can see a link
>>>>>>> "Edit this page"... in that way it's almost like a Wiki or a CMS, just
>>>>>>> without the whole overhead and only based on Git. Rebuild and publish of
>>>>>>> the site are very easy to configure e. g. with Github actions. And of
>>>>>>> course the visual style of Antora's output can be tweaked (
>>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>>
>>>>>>>
>>>>>>> Cheers
>>>>>>>
>>>>>>>
>>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>>
>>>>>>> Oh, I think you mean the documentation ==>
>>>>>>> https://fineract.apache.org/docs/current/
>>>>>>>
>>>>>>> That is generated at release time.
>>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>>
>>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>>
>>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain
>>>>>>> the process please, I do not recall.
>>>>>>>
>>>>>>> Where should we be updating the documentation? i.e. let's say we
>>>>>>> want to add "how to build"
>>>>>>>
>>>>>>> james
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <
>>>>>>> jamespdailey@gmail.com> wrote:
>>>>>>>
>>>>>>>> repo:apache/fineract-site
>>>>>>>>
>>>>>>>> serves up as https://fineract.apache.org
>>>>>>>>
>>>>>>>> so, it's just a simple javascript index.html
>>>>>>>>
>>>>>>>> why?
>>>>>>>>
>>>>>>>> Related: Please see email threads on wiki and website
>>>>>>>> improvements.
>>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>>> and
>>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>>> Cool. this all looks good. will chip away at working my way
>>>>>>>>> through it. Curious, how is fineract.apache.org served?
>>>>>>>>>
>>>>>>>>> -Rob
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>> --
>>>>> Sent from Gmail Mobile
>>>>>
>>>>> --
>> Sent from Gmail Mobile
>>
>
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
@James Dailey <ja...@gmail.com> Yes.
On Tue, Jun 20, 2023 at 6:10 PM James Dailey <ja...@gmail.com> wrote:
> John Are you volunteering to implement this?
>
>
> On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
>
>> Since we are using ascii doc, antora is a natural choice for
>> generating/publishing the doc as it allows for things like versioning,
>> generating docs from multiple sources and so on.
>>
>> I support the use of antora to generate the landing and other pages. See
>> attached video demonstrating the capabilities of antora.
>>
>> Thanks
>> Screen Recording 2023-06-19 at 1.44.05 PM.mov
>> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>>
>> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> Yes I am working on it to automate and make it easy to tweak the changes
>>> on the site.
>>> Sorry but my pc is there for repair that's why I can't show you the part
>>> but surely when I'll get my pc back will show the demo asap.
>>> Regards,
>>> Inzemam
>>>
>>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>>> cheetah@monkeysintown.com> wrote:
>>>
>>>> ... is there somewhere a preview available of that new stuff?
>>>> On 17/06/2023 15:11, James Dailey wrote:
>>>>
>>>> Inzemamul
>>>>
>>>> Are you saying you are building this for Fineract? And that it is close
>>>> to being pushed ?
>>>>
>>>> maybe others have questions about this?
>>>>
>>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
>>>> wrote:
>>>>
>>>>> What they have done is that they are based on ReactJs.
>>>>>
>>>>
>>>> And as far as I have completed the landing page is on HTML,CSS and
>>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>>> where also I have used a basic javascript crawler which will crawl
>>>>> specially the download files from cwiki or the apache download page and
>>>>> will update it on the website.
>>>>> For a CMS we have to work on REACT based project (what I prefer is
>>>>> NEXT JS as it's most easy to manage via github). The idea of edit this page
>>>>> will require the backend so there we needed either the LAMP stack or the
>>>>> MERN/MEAN stack.
>>>>> Regards,
>>>>> Inzemamul Haq
>>>>>
>>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>>> cheetah@monkeysintown.com> wrote:
>>>>>
>>>>>> ... the process is quite simple: anything we push to the Github repo
>>>>>> "https://github.com/apache/fineract-site"
>>>>>> <https://github.com/apache/fineract-site> in branch "asf-site" will
>>>>>> be picked up automatically (I believe) by Apache Infrastructure (probably
>>>>>> via a simple Git pull) to publish them on the Apache domain (in our case
>>>>>> fineract.apache.org).
>>>>>>
>>>>>> The documentation in HTML format under the "current" folder is
>>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>>> udates to Github.
>>>>>>
>>>>>> At the moment I do this manually (last update was a while ago). As
>>>>>> part of our release process we ship the current documentation in PDF
>>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>>> (tar.gz files).
>>>>>>
>>>>>> Note: there another set of HTML pages about the Fineract database
>>>>>> schema, tables, columns, relationships that are generated by another
>>>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>>>> handful of times; at the moment not automated... and no feedback if people
>>>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>>>> instead of HTML only... then we could include this also in the PDF
>>>>>> documentation; but for now it is what it is.
>>>>>>
>>>>>>
>>>>>> Having said that: I think it would be great to have a static site
>>>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>>>> think - doing a great job managing their web site. It's a combination of
>>>>>> automatically generated pages for the documentation (also based on
>>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>>> the documentation plus the most recent one that is continually updated from
>>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>>> capabilities here https://antora.org/) to aggregate all of this into
>>>>>> one coherent site. What I find really great about this approach: every page
>>>>>> has a Git reference; on pretty much every page you can see a link "Edit
>>>>>> this page"... in that way it's almost like a Wiki or a CMS, just without
>>>>>> the whole overhead and only based on Git. Rebuild and publish of the site
>>>>>> are very easy to configure e. g. with Github actions. And of course the
>>>>>> visual style of Antora's output can be tweaked (
>>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>>
>>>>>>
>>>>>> Cheers
>>>>>>
>>>>>>
>>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>>
>>>>>> Oh, I think you mean the documentation ==>
>>>>>> https://fineract.apache.org/docs/current/
>>>>>>
>>>>>> That is generated at release time.
>>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>>
>>>>>> it uses the Asciidoctor plugin I believe.
>>>>>>
>>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain
>>>>>> the process please, I do not recall.
>>>>>>
>>>>>> Where should we be updating the documentation? i.e. let's say we
>>>>>> want to add "how to build"
>>>>>>
>>>>>> james
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> repo:apache/fineract-site
>>>>>>>
>>>>>>> serves up as https://fineract.apache.org
>>>>>>>
>>>>>>> so, it's just a simple javascript index.html
>>>>>>>
>>>>>>> why?
>>>>>>>
>>>>>>> Related: Please see email threads on wiki and website improvements.
>>>>>>>
>>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>>> and
>>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>>>> wrote:
>>>>>>>
>>>>>>>> Cool. this all looks good. will chip away at working my way through
>>>>>>>> it. Curious, how is fineract.apache.org served?
>>>>>>>>
>>>>>>>> -Rob
>>>>>>>>
>>>>>>>>
>>>>>>>>> --
>>>> Sent from Gmail Mobile
>>>>
>>>> --
> Sent from Gmail Mobile
>
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
John Are you volunteering to implement this?
On Mon, Jun 19, 2023 at 4:00 AM John Gathogo <jo...@fiter.io> wrote:
> Since we are using ascii doc, antora is a natural choice for
> generating/publishing the doc as it allows for things like versioning,
> generating docs from multiple sources and so on.
>
> I support the use of antora to generate the landing and other pages. See
> attached video demonstrating the capabilities of antora.
>
> Thanks
> Screen Recording 2023-06-19 at 1.44.05 PM.mov
> <https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
>
> On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> Yes I am working on it to automate and make it easy to tweak the changes
>> on the site.
>> Sorry but my pc is there for repair that's why I can't show you the part
>> but surely when I'll get my pc back will show the demo asap.
>> Regards,
>> Inzemam
>>
>> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
>> cheetah@monkeysintown.com> wrote:
>>
>>> ... is there somewhere a preview available of that new stuff?
>>> On 17/06/2023 15:11, James Dailey wrote:
>>>
>>> Inzemamul
>>>
>>> Are you saying you are building this for Fineract? And that it is close
>>> to being pushed ?
>>>
>>> maybe others have questions about this?
>>>
>>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
>>> wrote:
>>>
>>>> What they have done is that they are based on ReactJs.
>>>>
>>>
>>> And as far as I have completed the landing page is on HTML,CSS and
>>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>>> where also I have used a basic javascript crawler which will crawl
>>>> specially the download files from cwiki or the apache download page and
>>>> will update it on the website.
>>>> For a CMS we have to work on REACT based project (what I prefer is NEXT
>>>> JS as it's most easy to manage via github). The idea of edit this page will
>>>> require the backend so there we needed either the LAMP stack or the
>>>> MERN/MEAN stack.
>>>> Regards,
>>>> Inzemamul Haq
>>>>
>>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>>> cheetah@monkeysintown.com> wrote:
>>>>
>>>>> ... the process is quite simple: anything we push to the Github repo
>>>>> "https://github.com/apache/fineract-site"
>>>>> <https://github.com/apache/fineract-site> in branch "asf-site" will
>>>>> be picked up automatically (I believe) by Apache Infrastructure (probably
>>>>> via a simple Git pull) to publish them on the Apache domain (in our case
>>>>> fineract.apache.org).
>>>>>
>>>>> The documentation in HTML format under the "current" folder is
>>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>>> udates to Github.
>>>>>
>>>>> At the moment I do this manually (last update was a while ago). As
>>>>> part of our release process we ship the current documentation in PDF
>>>>> (another output format of AsciiDoc) with the downloadable release artifacts
>>>>> (tar.gz files).
>>>>>
>>>>> Note: there another set of HTML pages about the Fineract database
>>>>> schema, tables, columns, relationships that are generated by another
>>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>>> handful of times; at the moment not automated... and no feedback if people
>>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>>> instead of HTML only... then we could include this also in the PDF
>>>>> documentation; but for now it is what it is.
>>>>>
>>>>>
>>>>> Having said that: I think it would be great to have a static site
>>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>>> think - doing a great job managing their web site. It's a combination of
>>>>> automatically generated pages for the documentation (also based on
>>>>> AsciiDoc), they even give you access to all long term support versions of
>>>>> the documentation plus the most recent one that is continually updated from
>>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>>> capabilities here https://antora.org/) to aggregate all of this into
>>>>> one coherent site. What I find really great about this approach: every page
>>>>> has a Git reference; on pretty much every page you can see a link "Edit
>>>>> this page"... in that way it's almost like a Wiki or a CMS, just without
>>>>> the whole overhead and only based on Git. Rebuild and publish of the site
>>>>> are very easy to configure e. g. with Github actions. And of course the
>>>>> visual style of Antora's output can be tweaked (
>>>>> https://docs.antora.org/antora-ui-default/).
>>>>>
>>>>>
>>>>> Cheers
>>>>>
>>>>>
>>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>>
>>>>> Oh, I think you mean the documentation ==>
>>>>> https://fineract.apache.org/docs/current/
>>>>>
>>>>> That is generated at release time.
>>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>>
>>>>> it uses the Asciidoctor plugin I believe.
>>>>>
>>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain
>>>>> the process please, I do not recall.
>>>>>
>>>>> Where should we be updating the documentation? i.e. let's say we
>>>>> want to add "how to build"
>>>>>
>>>>> james
>>>>>
>>>>>
>>>>>
>>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> repo:apache/fineract-site
>>>>>>
>>>>>> serves up as https://fineract.apache.org
>>>>>>
>>>>>> so, it's just a simple javascript index.html
>>>>>>
>>>>>> why?
>>>>>>
>>>>>> Related: Please see email threads on wiki and website improvements.
>>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>>> and
>>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>>> wrote:
>>>>>>
>>>>>>> Cool. this all looks good. will chip away at working my way through
>>>>>>> it. Curious, how is fineract.apache.org served?
>>>>>>>
>>>>>>> -Rob
>>>>>>>
>>>>>>>
>>>>>>>> --
>>> Sent from Gmail Mobile
>>>
>>> --
Sent from Gmail Mobile
Re: Fineract website
Posted by John Gathogo <jo...@fiter.io>.
Since we are using ascii doc, antora is a natural choice for
generating/publishing the doc as it allows for things like versioning,
generating docs from multiple sources and so on.
I support the use of antora to generate the landing and other pages. See
attached video demonstrating the capabilities of antora.
Thanks
Screen Recording 2023-06-19 at 1.44.05 PM.mov
<https://drive.google.com/file/d/1LL4aW3Sxjs1nhjhirMnHGggL-QAUmYBt/view?usp=drive_web>
On Sat, Jun 17, 2023 at 8:51 PM Inzemamul Haq <in...@gmail.com>
wrote:
> Yes I am working on it to automate and make it easy to tweak the changes
> on the site.
> Sorry but my pc is there for repair that's why I can't show you the part
> but surely when I'll get my pc back will show the demo asap.
> Regards,
> Inzemam
>
> On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
> cheetah@monkeysintown.com> wrote:
>
>> ... is there somewhere a preview available of that new stuff?
>> On 17/06/2023 15:11, James Dailey wrote:
>>
>> Inzemamul
>>
>> Are you saying you are building this for Fineract? And that it is close
>> to being pushed ?
>>
>> maybe others have questions about this?
>>
>> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
>> wrote:
>>
>>> What they have done is that they are based on ReactJs.
>>>
>>
>> And as far as I have completed the landing page is on HTML,CSS and
>>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>>> where also I have used a basic javascript crawler which will crawl
>>> specially the download files from cwiki or the apache download page and
>>> will update it on the website.
>>> For a CMS we have to work on REACT based project (what I prefer is NEXT
>>> JS as it's most easy to manage via github). The idea of edit this page will
>>> require the backend so there we needed either the LAMP stack or the
>>> MERN/MEAN stack.
>>> Regards,
>>> Inzemamul Haq
>>>
>>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>>> cheetah@monkeysintown.com> wrote:
>>>
>>>> ... the process is quite simple: anything we push to the Github repo
>>>> "https://github.com/apache/fineract-site"
>>>> <https://github.com/apache/fineract-site> in branch "asf-site" will be
>>>> picked up automatically (I believe) by Apache Infrastructure (probably via
>>>> a simple Git pull) to publish them on the Apache domain (in our case
>>>> fineract.apache.org).
>>>>
>>>> The documentation in HTML format under the "current" folder is
>>>> generated from the AsciiDoc (kind of a Markdown on steroids format) files.
>>>> Publishing again is a simple copy to the fineract-site repo and pushing the
>>>> udates to Github.
>>>>
>>>> At the moment I do this manually (last update was a while ago). As part
>>>> of our release process we ship the current documentation in PDF (another
>>>> output format of AsciiDoc) with the downloadable release artifacts (tar.gz
>>>> files).
>>>>
>>>> Note: there another set of HTML pages about the Fineract database
>>>> schema, tables, columns, relationships that are generated by another
>>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>>> handful of times; at the moment not automated... and no feedback if people
>>>> find this useful or not. It would be great if they could generate AsciiDoc
>>>> instead of HTML only... then we could include this also in the PDF
>>>> documentation; but for now it is what it is.
>>>>
>>>>
>>>> Having said that: I think it would be great to have a static site
>>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>>> think - doing a great job managing their web site. It's a combination of
>>>> automatically generated pages for the documentation (also based on
>>>> AsciiDoc), they even give you access to all long term support versions of
>>>> the documentation plus the most recent one that is continually updated from
>>>> Github. Addtionally they have a landing page, a section with blog entries
>>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>>> Antora (read: static site generator for AsciiDoc... more about its
>>>> capabilities here https://antora.org/) to aggregate all of this into
>>>> one coherent site. What I find really great about this approach: every page
>>>> has a Git reference; on pretty much every page you can see a link "Edit
>>>> this page"... in that way it's almost like a Wiki or a CMS, just without
>>>> the whole overhead and only based on Git. Rebuild and publish of the site
>>>> are very easy to configure e. g. with Github actions. And of course the
>>>> visual style of Antora's output can be tweaked (
>>>> https://docs.antora.org/antora-ui-default/).
>>>>
>>>>
>>>> Cheers
>>>>
>>>>
>>>> On 16/06/2023 22:00, James Dailey wrote:
>>>>
>>>> Oh, I think you mean the documentation ==>
>>>> https://fineract.apache.org/docs/current/
>>>>
>>>> That is generated at release time.
>>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>>
>>>> it uses the Asciidoctor plugin I believe.
>>>>
>>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain
>>>> the process please, I do not recall.
>>>>
>>>> Where should we be updating the documentation? i.e. let's say we want
>>>> to add "how to build"
>>>>
>>>> james
>>>>
>>>>
>>>>
>>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
>>>> wrote:
>>>>
>>>>> repo:apache/fineract-site
>>>>>
>>>>> serves up as https://fineract.apache.org
>>>>>
>>>>> so, it's just a simple javascript index.html
>>>>>
>>>>> why?
>>>>>
>>>>> Related: Please see email threads on wiki and website improvements.
>>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>>> and
>>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>>
>>>>>
>>>>>
>>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> Cool. this all looks good. will chip away at working my way through
>>>>>> it. Curious, how is fineract.apache.org served?
>>>>>>
>>>>>> -Rob
>>>>>>
>>>>>>
>>>>>>> --
>> Sent from Gmail Mobile
>>
>>
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
Yes I am working on it to automate and make it easy to tweak the changes
on the site.
Sorry but my pc is there for repair that's why I can't show you the part
but surely when I'll get my pc back will show the demo asap.
Regards,
Inzemam
On Sat, 17 Jun, 2023, 7:41 pm Aleksandar Vidakovic, <
cheetah@monkeysintown.com> wrote:
> ... is there somewhere a preview available of that new stuff?
> On 17/06/2023 15:11, James Dailey wrote:
>
> Inzemamul
>
> Are you saying you are building this for Fineract? And that it is close to
> being pushed ?
>
> maybe others have questions about this?
>
> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
> wrote:
>
>> What they have done is that they are based on ReactJs.
>>
>
> And as far as I have completed the landing page is on HTML,CSS and
>> Js(whose code I'll be pushing soon as I have given my pc for repairing)
>> where also I have used a basic javascript crawler which will crawl
>> specially the download files from cwiki or the apache download page and
>> will update it on the website.
>> For a CMS we have to work on REACT based project (what I prefer is NEXT
>> JS as it's most easy to manage via github). The idea of edit this page will
>> require the backend so there we needed either the LAMP stack or the
>> MERN/MEAN stack.
>> Regards,
>> Inzemamul Haq
>>
>> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
>> cheetah@monkeysintown.com> wrote:
>>
>>> ... the process is quite simple: anything we push to the Github repo
>>> "https://github.com/apache/fineract-site"
>>> <https://github.com/apache/fineract-site> in branch "asf-site" will be
>>> picked up automatically (I believe) by Apache Infrastructure (probably via
>>> a simple Git pull) to publish them on the Apache domain (in our case
>>> fineract.apache.org).
>>>
>>> The documentation in HTML format under the "current" folder is generated
>>> from the AsciiDoc (kind of a Markdown on steroids format) files. Publishing
>>> again is a simple copy to the fineract-site repo and pushing the udates to
>>> Github.
>>>
>>> At the moment I do this manually (last update was a while ago). As part
>>> of our release process we ship the current documentation in PDF (another
>>> output format of AsciiDoc) with the downloadable release artifacts (tar.gz
>>> files).
>>>
>>> Note: there another set of HTML pages about the Fineract database
>>> schema, tables, columns, relationships that are generated by another
>>> command line tool (SchemaCrawler). I think I generated these pages only a
>>> handful of times; at the moment not automated... and no feedback if people
>>> find this useful or not. It would be great if they could generate AsciiDoc
>>> instead of HTML only... then we could include this also in the PDF
>>> documentation; but for now it is what it is.
>>>
>>>
>>> Having said that: I think it would be great to have a static site
>>> generator to manage all pages of the Fineract site. Apache Camel is - I
>>> think - doing a great job managing their web site. It's a combination of
>>> automatically generated pages for the documentation (also based on
>>> AsciiDoc), they even give you access to all long term support versions of
>>> the documentation plus the most recent one that is continually updated from
>>> Github. Addtionally they have a landing page, a section with blog entries
>>> and various other pages. Most of it is based on AsciiDoc... they use then
>>> Antora (read: static site generator for AsciiDoc... more about its
>>> capabilities here https://antora.org/) to aggregate all of this into
>>> one coherent site. What I find really great about this approach: every page
>>> has a Git reference; on pretty much every page you can see a link "Edit
>>> this page"... in that way it's almost like a Wiki or a CMS, just without
>>> the whole overhead and only based on Git. Rebuild and publish of the site
>>> are very easy to configure e. g. with Github actions. And of course the
>>> visual style of Antora's output can be tweaked (
>>> https://docs.antora.org/antora-ui-default/).
>>>
>>>
>>> Cheers
>>>
>>>
>>> On 16/06/2023 22:00, James Dailey wrote:
>>>
>>> Oh, I think you mean the documentation ==>
>>> https://fineract.apache.org/docs/current/
>>>
>>> That is generated at release time.
>>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>>
>>> it uses the Asciidoctor plugin I believe.
>>>
>>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain the
>>> process please, I do not recall.
>>>
>>> Where should we be updating the documentation? i.e. let's say we want
>>> to add "how to build"
>>>
>>> james
>>>
>>>
>>>
>>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
>>> wrote:
>>>
>>>> repo:apache/fineract-site
>>>>
>>>> serves up as https://fineract.apache.org
>>>>
>>>> so, it's just a simple javascript index.html
>>>>
>>>> why?
>>>>
>>>> Related: Please see email threads on wiki and website improvements.
>>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>>> and
>>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>>
>>>>
>>>>
>>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
>>>> wrote:
>>>>
>>>>> Cool. this all looks good. will chip away at working my way through
>>>>> it. Curious, how is fineract.apache.org served?
>>>>>
>>>>> -Rob
>>>>>
>>>>>
>>>>>> --
> Sent from Gmail Mobile
>
>
Re: Fineract website
Posted by Aleksandar Vidakovic <ch...@monkeysintown.com>.
... is there somewhere a preview available of that new stuff?
On 17/06/2023 15:11, James Dailey wrote:
> Inzemamul
>
> Are you saying you are building this for Fineract? And that it is
> close to being pushed ?
>
> maybe others have questions about this?
>
> On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
> wrote:
>
> What they have done is that they are based on ReactJs.
>
>
> And as far as I have completed the landing page is on HTML,CSS and
> Js(whose code I'll be pushing soon as I have given my pc for
> repairing) where also I have used a basic javascript crawler which
> will crawl specially the download files from cwiki or the apache
> download page and will update it on the website.
> For a CMS we have to work on REACT based project (what I prefer is
> NEXT JS as it's most easy to manage via github). The idea of edit
> this page will require the backend so there we needed either the
> LAMP stack or the MERN/MEAN stack.
> Regards,
> Inzemamul Haq
>
> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic
> <ch...@monkeysintown.com> wrote:
>
> ... the process is quite simple: anything we push to the
> Github repo "https://github.com/apache/fineract-site"
> <https://github.com/apache/fineract-site> in branch "asf-site"
> will be picked up automatically (I believe) by Apache
> Infrastructure (probably via a simple Git pull) to publish
> them on the Apache domain (in our case fineract.apache.org
> <http://fineract.apache.org>).
>
> The documentation in HTML format under the "current" folder is
> generated from the AsciiDoc (kind of a Markdown on steroids
> format) files. Publishing again is a simple copy to the
> fineract-site repo and pushing the udates to Github.
>
> At the moment I do this manually (last update was a while
> ago). As part of our release process we ship the current
> documentation in PDF (another output format of AsciiDoc) with
> the downloadable release artifacts (tar.gz files).
>
> Note: there another set of HTML pages about the Fineract
> database schema, tables, columns, relationships that are
> generated by another command line tool (SchemaCrawler). I
> think I generated these pages only a handful of times; at the
> moment not automated... and no feedback if people find this
> useful or not. It would be great if they could generate
> AsciiDoc instead of HTML only... then we could include this
> also in the PDF documentation; but for now it is what it is.
>
>
> Having said that: I think it would be great to have a static
> site generator to manage all pages of the Fineract site.
> Apache Camel is - I think - doing a great job managing their
> web site. It's a combination of automatically generated pages
> for the documentation (also based on AsciiDoc), they even give
> you access to all long term support versions of the
> documentation plus the most recent one that is continually
> updated from Github. Addtionally they have a landing page, a
> section with blog entries and various other pages. Most of it
> is based on AsciiDoc... they use then Antora (read: static
> site generator for AsciiDoc... more about its capabilities
> here https://antora.org/) to aggregate all of this into one
> coherent site. What I find really great about this approach:
> every page has a Git reference; on pretty much every page you
> can see a link "Edit this page"... in that way it's almost
> like a Wiki or a CMS, just without the whole overhead and only
> based on Git. Rebuild and publish of the site are very easy to
> configure e. g. with Github actions. And of course the visual
> style of Antora's output can be tweaked
> (https://docs.antora.org/antora-ui-default/).
>
>
> Cheers
>
>
> On 16/06/2023 22:00, James Dailey wrote:
>> Oh, I think you mean the documentation ==>
>> https://fineract.apache.org/docs/current/
>>
>> That is generated at release time.
>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>
>> it uses the Asciidoctor plugin I believe.
>>
>> @Aleksandar Vidakovic
>> <ma...@monkeysintown.com> could you explain the
>> process please, I do not recall.
>>
>> Where should we be updating the documentation? i.e. let's
>> say we want to add "how to build"
>>
>> james
>>
>>
>>
>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey
>> <ja...@gmail.com> wrote:
>>
>> repo:apache/fineract-site
>>
>> serves up as https://fineract.apache.org
>>
>> so, it's just a simple javascript index.html
>>
>> why?
>>
>> Related: Please see email threads on wiki and website
>> improvements.
>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>
>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>> and
>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>
>>
>>
>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins
>> <ch...@gmail.com> wrote:
>>
>> Cool. this all looks good. will chip away at working
>> my way through it. Curious, how is
>> fineract.apache.org <http://fineract.apache.org> served?
>>
>> -Rob
>>>
>>>
> --
> Sent from Gmail Mobile
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
Inzemamul
Are you saying you are building this for Fineract? And that it is close to
being pushed ?
maybe others have questions about this?
On Sat, Jun 17, 2023 at 3:46 AM Inzemamul Haq <in...@gmail.com>
wrote:
> What they have done is that they are based on ReactJs.
>
And as far as I have completed the landing page is on HTML,CSS and Js(whose
> code I'll be pushing soon as I have given my pc for repairing) where also I
> have used a basic javascript crawler which will crawl specially the
> download files from cwiki or the apache download page and will update it on
> the website.
> For a CMS we have to work on REACT based project (what I prefer is NEXT JS
> as it's most easy to manage via github). The idea of edit this page will
> require the backend so there we needed either the LAMP stack or the
> MERN/MEAN stack.
> Regards,
> Inzemamul Haq
>
> On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
> cheetah@monkeysintown.com> wrote:
>
>> ... the process is quite simple: anything we push to the Github repo
>> "https://github.com/apache/fineract-site"
>> <https://github.com/apache/fineract-site> in branch "asf-site" will be
>> picked up automatically (I believe) by Apache Infrastructure (probably via
>> a simple Git pull) to publish them on the Apache domain (in our case
>> fineract.apache.org).
>>
>> The documentation in HTML format under the "current" folder is generated
>> from the AsciiDoc (kind of a Markdown on steroids format) files. Publishing
>> again is a simple copy to the fineract-site repo and pushing the udates to
>> Github.
>>
>> At the moment I do this manually (last update was a while ago). As part
>> of our release process we ship the current documentation in PDF (another
>> output format of AsciiDoc) with the downloadable release artifacts (tar.gz
>> files).
>>
>> Note: there another set of HTML pages about the Fineract database schema,
>> tables, columns, relationships that are generated by another command line
>> tool (SchemaCrawler). I think I generated these pages only a handful of
>> times; at the moment not automated... and no feedback if people find this
>> useful or not. It would be great if they could generate AsciiDoc instead of
>> HTML only... then we could include this also in the PDF documentation; but
>> for now it is what it is.
>>
>>
>> Having said that: I think it would be great to have a static site
>> generator to manage all pages of the Fineract site. Apache Camel is - I
>> think - doing a great job managing their web site. It's a combination of
>> automatically generated pages for the documentation (also based on
>> AsciiDoc), they even give you access to all long term support versions of
>> the documentation plus the most recent one that is continually updated from
>> Github. Addtionally they have a landing page, a section with blog entries
>> and various other pages. Most of it is based on AsciiDoc... they use then
>> Antora (read: static site generator for AsciiDoc... more about its
>> capabilities here https://antora.org/) to aggregate all of this into one
>> coherent site. What I find really great about this approach: every page has
>> a Git reference; on pretty much every page you can see a link "Edit this
>> page"... in that way it's almost like a Wiki or a CMS, just without the
>> whole overhead and only based on Git. Rebuild and publish of the site are
>> very easy to configure e. g. with Github actions. And of course the visual
>> style of Antora's output can be tweaked (
>> https://docs.antora.org/antora-ui-default/).
>>
>>
>> Cheers
>>
>>
>> On 16/06/2023 22:00, James Dailey wrote:
>>
>> Oh, I think you mean the documentation ==>
>> https://fineract.apache.org/docs/current/
>>
>> That is generated at release time.
>> https://github.com/apache/fineract/tree/develop/fineract-doc
>>
>> it uses the Asciidoctor plugin I believe.
>>
>> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain the
>> process please, I do not recall.
>>
>> Where should we be updating the documentation? i.e. let's say we want
>> to add "how to build"
>>
>> james
>>
>>
>>
>> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
>> wrote:
>>
>>> repo:apache/fineract-site
>>>
>>> serves up as https://fineract.apache.org
>>>
>>> so, it's just a simple javascript index.html
>>>
>>> why?
>>>
>>> Related: Please see email threads on wiki and website improvements.
>>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>>> and
>>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>>
>>>
>>>
>>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com> wrote:
>>>
>>>> Cool. this all looks good. will chip away at working my way through it.
>>>> Curious, how is fineract.apache.org served?
>>>>
>>>> -Rob
>>>>
>>>>
>>>>> --
Sent from Gmail Mobile
Re: Fineract website
Posted by Inzemamul Haq <in...@gmail.com>.
What they have done is that they are based on ReactJs. And as far as I have
completed the landing page is on HTML,CSS and Js(whose code I'll be pushing
soon as I have given my pc for repairing) where also I have used a basic
javascript crawler which will crawl specially the download files from cwiki
or the apache download page and will update it on the website.
For a CMS we have to work on REACT based project (what I prefer is NEXT JS
as it's most easy to manage via github). The idea of edit this page will
require the backend so there we needed either the LAMP stack or the
MERN/MEAN stack.
Regards,
Inzemamul Haq
On Sat, Jun 17, 2023 at 2:46 PM Aleksandar Vidakovic <
cheetah@monkeysintown.com> wrote:
> ... the process is quite simple: anything we push to the Github repo
> "https://github.com/apache/fineract-site"
> <https://github.com/apache/fineract-site> in branch "asf-site" will be
> picked up automatically (I believe) by Apache Infrastructure (probably via
> a simple Git pull) to publish them on the Apache domain (in our case
> fineract.apache.org).
>
> The documentation in HTML format under the "current" folder is generated
> from the AsciiDoc (kind of a Markdown on steroids format) files. Publishing
> again is a simple copy to the fineract-site repo and pushing the udates to
> Github.
>
> At the moment I do this manually (last update was a while ago). As part of
> our release process we ship the current documentation in PDF (another
> output format of AsciiDoc) with the downloadable release artifacts (tar.gz
> files).
>
> Note: there another set of HTML pages about the Fineract database schema,
> tables, columns, relationships that are generated by another command line
> tool (SchemaCrawler). I think I generated these pages only a handful of
> times; at the moment not automated... and no feedback if people find this
> useful or not. It would be great if they could generate AsciiDoc instead of
> HTML only... then we could include this also in the PDF documentation; but
> for now it is what it is.
>
>
> Having said that: I think it would be great to have a static site
> generator to manage all pages of the Fineract site. Apache Camel is - I
> think - doing a great job managing their web site. It's a combination of
> automatically generated pages for the documentation (also based on
> AsciiDoc), they even give you access to all long term support versions of
> the documentation plus the most recent one that is continually updated from
> Github. Addtionally they have a landing page, a section with blog entries
> and various other pages. Most of it is based on AsciiDoc... they use then
> Antora (read: static site generator for AsciiDoc... more about its
> capabilities here https://antora.org/) to aggregate all of this into one
> coherent site. What I find really great about this approach: every page has
> a Git reference; on pretty much every page you can see a link "Edit this
> page"... in that way it's almost like a Wiki or a CMS, just without the
> whole overhead and only based on Git. Rebuild and publish of the site are
> very easy to configure e. g. with Github actions. And of course the visual
> style of Antora's output can be tweaked (
> https://docs.antora.org/antora-ui-default/).
>
>
> Cheers
>
>
> On 16/06/2023 22:00, James Dailey wrote:
>
> Oh, I think you mean the documentation ==>
> https://fineract.apache.org/docs/current/
>
> That is generated at release time.
> https://github.com/apache/fineract/tree/develop/fineract-doc
>
> it uses the Asciidoctor plugin I believe.
>
> @Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain the
> process please, I do not recall.
>
> Where should we be updating the documentation? i.e. let's say we want to
> add "how to build"
>
> james
>
>
>
> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
> wrote:
>
>> repo:apache/fineract-site
>>
>> serves up as https://fineract.apache.org
>>
>> so, it's just a simple javascript index.html
>>
>> why?
>>
>> Related: Please see email threads on wiki and website improvements.
>> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
>> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
>> and
>> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>>
>>
>>
>> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com> wrote:
>>
>>> Cool. this all looks good. will chip away at working my way through it.
>>> Curious, how is fineract.apache.org served?
>>>
>>> -Rob
>>>
>>>
>>>>
Re: Fineract website
Posted by Aleksandar Vidakovic <ch...@monkeysintown.com>.
... the process is quite simple: anything we push to the Github repo
"https://github.com/apache/fineract-site" in branch "asf-site" will be
picked up automatically (I believe) by Apache Infrastructure (probably
via a simple Git pull) to publish them on the Apache domain (in our case
fineract.apache.org).
The documentation in HTML format under the "current" folder is generated
from the AsciiDoc (kind of a Markdown on steroids format) files.
Publishing again is a simple copy to the fineract-site repo and pushing
the udates to Github.
At the moment I do this manually (last update was a while ago). As part
of our release process we ship the current documentation in PDF (another
output format of AsciiDoc) with the downloadable release artifacts
(tar.gz files).
Note: there another set of HTML pages about the Fineract database
schema, tables, columns, relationships that are generated by another
command line tool (SchemaCrawler). I think I generated these pages only
a handful of times; at the moment not automated... and no feedback if
people find this useful or not. It would be great if they could generate
AsciiDoc instead of HTML only... then we could include this also in the
PDF documentation; but for now it is what it is.
Having said that: I think it would be great to have a static site
generator to manage all pages of the Fineract site. Apache Camel is - I
think - doing a great job managing their web site. It's a combination of
automatically generated pages for the documentation (also based on
AsciiDoc), they even give you access to all long term support versions
of the documentation plus the most recent one that is continually
updated from Github. Addtionally they have a landing page, a section
with blog entries and various other pages. Most of it is based on
AsciiDoc... they use then Antora (read: static site generator for
AsciiDoc... more about its capabilities here https://antora.org/) to
aggregate all of this into one coherent site. What I find really great
about this approach: every page has a Git reference; on pretty much
every page you can see a link "Edit this page"... in that way it's
almost like a Wiki or a CMS, just without the whole overhead and only
based on Git. Rebuild and publish of the site are very easy to configure
e. g. with Github actions. And of course the visual style of Antora's
output can be tweaked (https://docs.antora.org/antora-ui-default/).
Cheers
On 16/06/2023 22:00, James Dailey wrote:
> Oh, I think you mean the documentation ==>
> https://fineract.apache.org/docs/current/
>
> That is generated at release time.
> https://github.com/apache/fineract/tree/develop/fineract-doc
>
> it uses the Asciidoctor plugin I believe.
>
> @Aleksandar Vidakovic <ma...@monkeysintown.com> could you
> explain the process please, I do not recall.
>
> Where should we be updating the documentation? i.e. let's say we
> want to add "how to build"
>
> james
>
>
>
> On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
> wrote:
>
> repo:apache/fineract-site
>
> serves up as https://fineract.apache.org
>
> so, it's just a simple javascript index.html
>
> why?
>
> Related: Please see email threads on wiki and website improvements.
> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
> and
> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>
>
>
> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com>
> wrote:
>
> Cool. this all looks good. will chip away at working my way
> through it. Curious, how is fineract.apache.org
> <http://fineract.apache.org> served?
>
> -Rob
>>
>>
Re: Fineract website
Posted by James Dailey <ja...@gmail.com>.
Oh, I think you mean the documentation ==>
https://fineract.apache.org/docs/current/
That is generated at release time.
https://github.com/apache/fineract/tree/develop/fineract-doc
it uses the Asciidoctor plugin I believe.
@Aleksandar Vidakovic <ch...@monkeysintown.com> could you explain the
process please, I do not recall.
Where should we be updating the documentation? i.e. let's say we want to
add "how to build"
james
On Fri, Jun 16, 2023 at 12:43 PM James Dailey <ja...@gmail.com>
wrote:
> repo:apache/fineract-site
>
> serves up as https://fineract.apache.org
>
> so, it's just a simple javascript index.html
>
> why?
>
> Related: Please see email threads on wiki and website improvements.
> https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8
> <https://lists.apache.org/thread/tgd670st1z2oxwlqykw6cdsf6ctlxbn8>
> and
> https://lists.apache.org/thread/7b3doc4kryn0mxxyy3ydj567hbr2s0mz
>
>
>
> On Fri, Jun 16, 2023 at 7:26 AM Rob Tompkins <ch...@gmail.com> wrote:
>
>> Cool. this all looks good. will chip away at working my way through it.
>> Curious, how is fineract.apache.org served?
>>
>> -Rob
>>
>>
>>>