Add info about when/how often syncing is attempted

[michaelkohn]

Would be useful to document when syncing is attempted.

Here are some relevant resources that could be rolled up and documented in the "Sync Status" section (or elsewhere).

• Forum Post with all (well, most of) the details
• Trigger a sync immediately when a doc changes locally cht-core#5738 (comment)
• Sync status sometimes says all reports synced when there are changes yet to sync cht-core#6299

[latin-panda]

@michaelkohn, I guess what you need is telemetry, right? Is the number of times people sync okay?

[michaelkohn]

@latin-panda this is just about documenting the current sync strategy on the docs site :-) ... I believe the forum post contains most of the details (though I'm not sure if things have changed at all since 2019), I just want that to be on the docs site somewhere.

[latin-panda]

Oh okay, easy then. Thanks @michaelkohn

[latin-panda]

Ideas to document:

• Internal process
• Different types of sync (manual, automated)
• Type of documents / data
  Not sure if to also cover when it prompts to reload the app? (when config changes, when there's a new version of the app (src), when there's a new form, etc)

[michaelkohn]

Yep.... some important details we'd want to cover:

1. That offline users have (I think) two databases that get synced (the main one and the meta DB)
2. The types of docs you'll find in each of those DBs (telemetry, feedback, etc... in meta | reports, contacts, etc... in the main DB)
3. When do each of these databases normally get synced (automatically while there's a connection, whenever there is a change, when the app notices it comes back online, etc...)
4. Any differences in how things are handled if there are server changes vs. client changes
5. What other things will trigger a sync (logging in, reloading the app, etc....)

Not sure if to also cover when it prompts to reload the app?

Jenni did some good investigation in this slack thread. I'd love for us to document this as well, but am OK doing it as a separate issue.

[latin-panda]

@Benmuiruri is there anything pending? Can we close the ticket?

[Benmuiruri]

Closed by #1243

[michaelkohn]

Quick link to where this got included on the docs site

https://docs.communityhealthtoolkit.org/apps/concepts/navigation/#sync-status