Closed data-sync-user closed 2 years ago
data-sync-user
commented
2 years ago ➤ Bryan Sieber commented:
Some first steps: https://github.com/mozilla-it/ctms-api/pull/306 ( https://github.com/mozilla-it/ctms-api/pull/306|smart-link ) https://github.com/mozilla-it/ctms-api/pull/304 ( https://github.com/mozilla-it/ctms-api/pull/304|smart-link )
data-sync-user
commented
2 years ago ➤ Bryan Sieber commented:
Reached out to Alan to see if there was any diagramming or documentation they had for the infra; he presented me with a few links:
Will be looking through this documentation as well.
--
Next steps involve: cleaning up the existing documentation, revising the general overview architecture, extracting details from (https://docs.google.com/document/d/17YLKNlk6hE7arbLVOAlm-eOXt_hD6UleJGKrZ8KRiwM/edit?disco=AAAAPx_OqiA&usp_dm=true ( https://docs.google.com/document/d/17YLKNlk6hE7arbLVOAlm-eOXt_hD6UleJGKrZ8KRiwM/edit?disco=AAAAPx_OqiA&usp_dm=true|smart-link ) ), determining if other diagrams are worth constructing…
data-sync-user
commented
2 years ago ➤ Bryan Sieber commented:
!image-20211202-190249.png|width=3110,height=1380!
As a CTMS engineer, I want to improve the coverage and quality of documentation, so that new engineers who work on CTMS in the future will have an easier time both becoming productive and diagnosing issues.
Acceptance criteria: Re-architect how the information is presented.
Possibly remove the auto-documentation logic that isn’t performing up to expectation. Adding Acoustic into the diagrams, moving some of the important Gdoc info into the repo, …
┆Issue is synchronized with this Jira Story ┆Attachments: image-20211202-190249.png