[Tracker] Season of Docs - 2022: Links/urls: docs, planners, tickets, PRs

[tapaswenipathak]

Scope

• https://mifosforge.jira.com/wiki/spaces/RES/pages/3038248961/Season+of+Docs+-+2022#proposal
• proposal: https://paper.dropbox.com/doc/Statement-of-Interest-Update-Platform-and-Collaboration-Documentation-for-Launch-of-Mifos-X-3.0-GSoD22--BkTM8jYcWRw8L7_aE527L6ExAg-eUmotfwsfjazWgJoHZg3n
• diagrams from gsod'2021: https://paper.dropbox.com/doc/Mifos-Documentation-Revision-2022--BkTHnvKz1zSTcY~rmxY19yqYAg-XVgdouRly5tJlNBfd370F
• refs: https://docs.google.com/document/d/1x_ucMp8O3fWwwtBCdLm_IwsO31LLg5C96LJugR-Ryec/edit#heading=h.845tlywdunr2
• draft outline: https://docs.google.com/document/d/1iSXA6fnucHq8Kz17ZlluPVCZ3QRgDpOqvaIktwBQNE0/edit

Prioritised hierarchy for information consumption by the user

1. mifos.org,
2. Developer/Contributor Docs - https://mifos.readme.io/docs/getting-started (readme.io) (Technical, how to build, contribute, extend)
3. Apache wiki
4. ASCII doc - https://fineract.apache.org/docs/current/
5. User/Implementer Docs - docs.mifos.org (gitbook) (More around use case, business need, functionality), https://mifos.gitbook.io/docs/
6. Mifos Wiki
7. OpenMF GitHub wiki

Tickets

• [docs.mifos.org] Create/Update empty pages android-client#1877
• [android-client][ github wiki] Standardize Documentation android-client#1876
• [mifosx wiki][usablility+design docs] Update Product Roadmap android-client#1875
• [demo] Update user and developer information entry points community-app#3483
• [repo docs][github wiki][readme] Standardize documentation community-app#3482
• [mifos.gitbook.io] update/consolidate information as primary entry point for developers and users. mobile-wallet#1332
• [github wiki][reduce entry points/dups] Standardize Documentation mobile-wallet#1331
• [github wiki] Standardize Documentation mifos-mobile-cn#229
• [github wiki] Standardize Documentation mifos-mobile#1863
• [openmf.github.io/mobileapps.github.io] update/add relevant information mobileapps.github.io#1
• [docs.mifos.org] [Outlines]: Pages on docs.mifos.org #15
• [GitBook] docs.mifos.org is not in sync with GitHub repository OpenMF/mifos-documentation #16
• Outlines: OpenMF: User/Implementer Docs and Developer/Contributor Docs #17
• [mifos.readme.io] Create/Update pages #18

cc @edcable @vidakovic @luckyman20.

[tapaswenipathak]

Ref: Update and refine documentation to reflect new DevOps tooling for deployment of the platform and Payment Hub EE including Terraform scripts, Configurable Helm Charts, Kubernetes and Containerization Optimations.

https://mifos.gitbook.io/docs/payment-hub-ee/overview/deployment-models/devops-tooling-for-deployment

[tapaswenipathak]

Ref: Draft new documentation on how to install, deploy and configure Payment Hub EE

• https://mifos.gitbook.io/docs/payment-hub-ee/overview/installation-instructions
• https://mifos.gitbook.io/docs/payment-hub-ee/overview/deployment-models

[tapaswenipathak]

Ref: Draft new documentation outlining functionality of payment hub, each of its new modules, and use cases it supports

• https://mifos.gitbook.io/docs/payment-hub-ee/business-overview/benefits-of-payment-hub-ee
• https://mifos.gitbook.io/docs/payment-hub-ee/business-overview/target-users-of-payment-hub-ee
• https://mifos.gitbook.io/docs/payment-hub-ee/overview
• https://mifos.gitbook.io/docs/payment-hub-ee/business-overview/target-users-of-payment-hub-ee

[tapaswenipathak]

Ref: Update documentation and screenshots in user manual to reflect design of new web app

• Sign in page: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/sign-in-page
• Welcome page: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/welcome-page
• Dashboards page: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/untitled
• List Page: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/list-page
• Menu Page: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/menu-page
• Form Page: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/form-page
• Clients-Groups-Centers Navigation: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/clients-groups-centers-navigation
• Navigation Tool: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/navigation-tool
• Global Search: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/global-search
• Loan Product and Accounting with Mifos: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/loan-product-and-accounting-with-mifos
• Reports: https://docs.mifos.org/mifosx/user-manual/for-all-users/reports
• Standard Reports Shipped in Mifos X: https://docs.mifos.org/mifosx/user-manual/for-all-users/reports/standard-reports-shipped-in-mifos-x
• Standard Reports Field Descriptions: https://docs.mifos.org/mifosx/user-manual/for-all-users/reports/standard-reports-field-descriptions
• Custom Reports: https://docs.mifos.org/mifosx/user-manual/for-all-users/reports/custom-reports
• XBRL Reporting: https://docs.mifos.org/mifosx/user-manual/for-all-users/reports/xbrl-reporting
• Reports: https://docs.mifos.org/mifosx/user-manual/for-all-users/reports
• Initial System Set Up: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/initial-system-set-up
• Administration: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/administration
• Organization: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/administration/organization
• System: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/administration/system
• Products: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/administration/products
• Templates: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/administration/templates
• mifos dropdown: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/administration/mifos-dropdown
• Clients-Groups-Centers Navigation: https://docs.mifos.org/mifosx/user-manual/for-all-users/untitled/clients-groups-centers-navigation
• Clients, Groups and Centers: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/clients-groups-and-centers
• Manage Clients: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/clients-groups-and-centers/manage-clients
• Client Relationship Management: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/clients-groups-and-centers/manage-clients/client-relationship-management
• Manage Groups: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/clients-groups-and-centers/manage-groups
• Manage Centers: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/clients-groups-and-centers/manage-centers
• Accounting: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting
• Chart of Accounts - General Ledger Setup: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/chart-of-accounts-general-ledger-setup
• Accounts linked to Financial Activities: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/accounts-linked-to-financial-activities
• Migrate opening balances (Office-wise): https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/migrate-opening-balances-office-wise
• Accounting Rules: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/accounting-rules
• Provisioning Entries: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/provisioning-entries
• Print General Ledger Listing: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/print-general-ledger-listing
• How To Enter GL Opening Balance: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/accounting/how-to-enter-gl-opening-balance
• Configure Notifications: https://docs.mifos.org/mifosx/user-manual/for-administrators-mifos-x-platform/configure-notifications
• Add Journal Entries: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounting-operations/add-journal-entries
• Searching Accounting Transactions: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounting-operations/searching-accounting-transactions
• Frequent Postings: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounting-operations/frequent-postings
• Advanced Accounting Rules: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounting-operations/advanced-accounting-rules
• Closing Entries: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounting-operations/closing-entries
• Accruals: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounting-operations/accruals
• Deposit Accounts: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounts-and-transactions/deposit-accounts
• Loan Accounts: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounts-and-transactions/loan-accounts
• Overdraft account: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounts-and-transactions/overdraft-account
• Saving Accounts: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounts-and-transactions/saving-accounts
• Share Accounts: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/accounts-and-transactions/share-accounts
• Checker Inbox & Tasks: https://docs.mifos.org/mifosx/user-manual/for-operational-users-mifos-x-web-app/checker-inbox-and-tasks
• Side Bar - Features: https://docs.mifos.org/mifosx/user-manual/side-bar-features
• Checker inbox and tasks: https://docs.mifos.org/mifosx/user-manual/side-bar-features/checker-inbox-and-tasks
• Collection sheet: https://docs.mifos.org/mifosx/user-manual/side-bar-features/collection-sheet
• Help.: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown/help
• Individual collection sheet: https://docs.mifos.org/mifosx/user-manual/side-bar-features/individual-collection-sheet
• Keyboard short-cuts: https://docs.mifos.org/mifosx/user-manual/side-bar-features/keyboard-short-cuts
• Navigation: https://docs.mifos.org/mifosx/user-manual/side-bar-features/navigation
• Others - mifos dropdown: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown
• Profile: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown/profile
• Settings: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown/settings
• Date format: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown/settings/date-format
• Language: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown/settings/language
• Signout: https://docs.mifos.org/mifosx/user-manual/others-mifos-dropdown/signout