Refine documentation for tuning and indexing to optimize performance based on PostgreSQL and Eclipselink enhancements. #2648
Conversation
| @@ -0,0 +1,114 @@ | |||
| = Fineract Database Handling | |||
There was a problem hiding this comment.
Rather call it Database Support
| @@ -0,0 +1,114 @@ | |||
| = Fineract Database Handling | |||
|
|
|||
| == Fineract Database Upgrades | |||
There was a problem hiding this comment.
What's this section title, upgrades? Upgrades of what? Below the text is about the different database supports.
|
|
||
| === Background | ||
|
|
||
| The Mifos team has stated that non-backward compatible database upgrades are |
There was a problem hiding this comment.
I don't think we should say "The Mifos team". This is a community driven project under the Apache umbrella, not a Mifos driven project.
There was a problem hiding this comment.
i don't think we should add this doc at all as customer documenation. More of a planning and ideas doc. we need to discuss this on where and why this doc can find a place. cc @edcable.
There was a problem hiding this comment.
@tapaswenipathak as you have noted and as @jdailey suggested, this documentation shouldn't include any of the rationale based on customer's needs of why the changes were made. You are both correct that this portion of the documentation shouldn't include all of this background which almost seems like a case study.
Regarding @galovics comment, we should refer to it being a community-driven project under Apache umbrella but to give you context Arnold, these documentation-related efforts are all purely Mifos-driven as part of our Google Season of Docs project that we secured with support from Google.
Intent of this section were to note the changes that were made to support PostgreSQL and Eclipselink, (to the extent that we can), the changes that needed to be made to support PostgreSQL vs MySQL/MariaDB, the process for developers/implementers to upgrade to benefit from these changes and then to specifically document the tuning and indexing specific to PostgreSQL to achieve optimal performance.
|
|
||
| == Tuning and Indexing | ||
|
|
||
| To optimize performance based on PostgreSQL and Eclipselink enhancements, tuning |
There was a problem hiding this comment.
cc @mdallos.
engineering and implementation is work in progress
|
This pull request seems to be stale. Are you still planning to work on it? We will automatically close it in 30 days. |
Ref: openMF/mifos-documentation#14
TODO:
cc @edcable.
Description
Describe the changes made and why they were made.
Ignore if these details are present on the associated Apache Fineract JIRA ticket.
Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
Write the commit message as per https://github.com/apache/fineract/#pull-requests
Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
Create/update unit or integration tests for verifying the changes made.
Follow coding conventions at https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions.
Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes
Submission is not a "code dump". (Large changes can be made "in repository" via a branch. Ask on the developer mailing list for guidance, if required.)
FYI our guidelines for code reviews are at https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide.