Add customer documentation for read/write/batch API operation performance enhancing separation #2644
Conversation
…ance enhancing separation
| @@ -0,0 +1,115 @@ | |||
| = Introducing Performance Enhancing Read/Write/Batch API Operation Separation | |||
There was a problem hiding this comment.
I'm not really sure why we created a new adoc file and calling it api-performance. Either it should be in the architecture doc or a brand new file which is specific to read/write/batch separation.
There was a problem hiding this comment.
good point, naming the file is still open for discussion; do you think a file name as api-performance-enhancement or improvement can have customer documentation on the best practices to work with api to get best performance? cc @edcable.
| @@ -0,0 +1,115 @@ | |||
| = Introducing Performance Enhancing Read/Write/Batch API Operation Separation | |||
|
|
|||
There was a problem hiding this comment.
Also, this new file is never referenced in the index file so it doesn't appear anywhere.
|
|
||
| == Environment Variables | ||
|
|
||
| Using environment variables, the three instance types performance enhancing |
There was a problem hiding this comment.
Please no manual line breaks... see also other parts of the doc
tapaswenipathak
force-pushed
the
read-write-batch-customer-docs
branch
from
033d3aa to
118a71c
Compare
|
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.
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.