I would also wonder where you keep the source that backs the docs so that I can contribute there as I work my way through standing up a local env.
Cheers, -ROb > On Jun 12, 2023, at 1:36 PM, James Dailey <[email protected]> wrote: > > I should have started with: > > * This is a question we get a lot - how to get started as a developer > * The advice we have given is to run Fineract via Docker-compose > > So, that should be straightforward and we should make sure this is up to > date: > https://hub.docker.com/r/apache/fineract > > > On Mon, Jun 12, 2023 at 12:11 PM James Dailey <[email protected] > <mailto:[email protected]>> wrote: >> I don't think we need more than Docker to get most developers going. >> Agreed? >> (let's drop minikube or whatevers) >> >> and, what is the base of our current Docker? I proposed Alpine a few years >> back, but cannot remember what we used. Can we get an update going? >> >> the documentation about this should be simple to follow >> >> Maybe we just list those other deployment ideas for "other ideas to do" - >> more of an invitation than something that we support in our documentation. >> >> Any objection to those kinds of changes to the documentation ? >> >> >> >> ---------- Forwarded message --------- >> From: James Dailey <[email protected] <mailto:[email protected]>> >> Date: Sat, Apr 8, 2023 at 11:44 AM >> Subject: Re: Website and Wiki for Fineract updates >> To: <[email protected] <mailto:[email protected]>> >> >> >> Hi Bruce - Good to know about those gaps in deployment and tools, but are >> those the only gaps in the documentation? >> >> So, question to you: is it already sufficiently clear on these topics: >> * explaining what the software does >> * explaining the architecture >> * explaining relationship between different components >> * what features are in each release >> * how to set up development environment >> * how to access APIs >> * how to find additional resources >> >> I did ask for 3-5 priority things, so please do try to identify where we >> start, even from your very long list or maybe adding to it, can we get your >> opinion on a few key things? >> >> What would you say is a priority? >> >> As a project, I think we need to simply and only offer one or two deployment >> options in our documentation, that way we can focus on getting those >> accurate and keeping them up to date. Others are of course free to offer >> their own improvements and alternatives. >> >> All - comments welcome. >> >> Thanks, >> James >> >> >> >> On Sat, Apr 8, 2023 at 10:33 AM Bruce <[email protected] >> <mailto:[email protected]>> wrote: >>> Hi, >>> >>> I hope this email finds you well. I wanted to share some observations after >>> going through the documentation for Fineract again. >>> >>> While the documentation provides an overview of deployment options here >>> https://fineract.apache.org/docs/current/#_deployment , I noticed that >>> several options, such as Docker Compose, Tomcat, Undertow, Jetty, JBoss, >>> Weblogic, and Payara, are marked as TBD, indicating a lack of content and >>> guidance for users. There is also no deployment content on Kubernetes, AWS >>> and Google Cloud. Let's address this. >>> >>> Additionally, the Fineract Development section here >>> https://fineract.apache.org/docs/current/#_fineract_development_environment >>> appears to be incomplete and in need of further content to cover important >>> topics related to Fineract development. This section also includes topics >>> marked as "TBD" on the website, such as Docker, Docker Compose, Podman, >>> Rancher Docker Desktop, IDE selection and configuration (including >>> IntelliJ, Eclipse, and VSCode), Kubernetes deployment and management, >>> Minikube, Microk8s, K3d, Helm Charts, and installation and usage of various >>> development tools like Brew for MacOS and Linux. I propose that the >>> community contibutes content for the following topics: >>> >>> >>> Docker: how to install, run, and use Docker containers for Fineract >>> Docker Compose: how to use Docker Compose to orchestrate multiple >>> containers for Fineract >>> Podman: how to use Podman as an alternative to Docker for running containers >>> Rancher Docker Desktop: how to use Rancher Docker Desktop to run Kubernetes >>> clusters on one's local machine >>> IDE: how to choose and configure an IDE for Fineract development >>> IntelliJ: how to set up and use IntelliJ IDEA as an IDE for Fineract >>> Eclipse: how to set up and use Eclipse as an IDE for Fineract >>> VSCode: how to set up and use VSCode as an IDE for Fineract >>> Kubernetes: how to deploy and manage Fineract on Kubernetes clusters >>> Minikube: how to use Minikube to run a local Kubernetes cluster for Fineract >>> Microk8s: how to use Microk8s to run a lightweight Kubernetes cluster for >>> Fineract >>> K3d: how to use K3d to run a Kubernetes cluster in Docker for Fineract >>> Helm Charts: how to use Helm Charts to package and deploy Fineract >>> applications on Kubernetes >>> Tools: how to install and use various tools that can help one with Fineract >>> development >>> Brew: how to install and use Brew for MacOS and Linux >>> >>> By actively addressing these gaps in the documentation, we can provide >>> valuable support to the Fineract community and further showcase the >>> flexibility and compatibility of Fineract with different technologies and >>> platforms. >>> >>> I look forward to collaborating with the community to contribute content >>> for these important topics and improve the overall documentation for >>> Fineract. >>> >>> >>> Best Regards >>> >>> Bruce >>>
