Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #1403

Closed
Tracked by #1385
mahalakshme opened this issue Sep 22, 2023 · 2 comments
Closed
Tracked by #1385

Update documentation #1403

mahalakshme opened this issue Sep 22, 2023 · 2 comments
Assignees

Comments

@mahalakshme
Copy link

mahalakshme commented Sep 22, 2023

Acceptance criteria:

  • https://avni.readme.io/docs/component-architecture - is not updated. Add lambda, media server, etl, integration-server, glific and exotel integrations which are now part of our main components to the diagram.
  • Also update database guide: https://avni.readme.io/docs/database-guide to add connection and table details regarding media database
    • Add link of glific messaging db design to database guide.
  • Add instructions to setup avni-media codebase in the setup guide. Content available here. Can be linked to or copy pasted.
  • Difference between old and new longitudinal export
  • Writing rules page is not in sync with the what is passed by the platform. Should also document which methods from Individual Service and any other service is available to the implementer.
  • about Attendance Form Element with gif - need to cover options like 'Display all group members' and 'Search' options.
  • Example usage for append_manual_update_history function since currently it is not used in the right manner for data scripts executed.
  • About adding group members via CSV upload. This has not been updated here and it is not clear that id means uuid of group and member that displays in the URL in the data entry app.
@mahalakshme mahalakshme changed the title Update architecture diagram to have updated documentation Update documentation Sep 22, 2023
@petmongrels petmongrels self-assigned this Dec 29, 2023
petmongrels added a commit to avniproject/avni-db-model that referenced this issue Jan 2, 2024
…ption and another full dump. upgraded node version.
petmongrels added a commit to avniproject/avni-db-model that referenced this issue Jan 2, 2024
@petmongrels
Copy link

don't have knowledge about:

  • about Attendance Form Element with gif - need to cover options like 'Display all group members' and 'Search' options.
  • About adding group members via CSV upload

@mahalakshme
Copy link
Author

@petmongrels will move the above items to separate card, and will move this to QA Ready.

will mark as Tech card since documentation is for technical details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

3 participants