Uploaded image for project: 'Compass '
  1. Compass
  2. COMPASS-8058

Generate markdown Compass tracking plan from comments

    • Developer Tools
    • 5
    • Not Needed

      At present, the tracking plan for Compass (event names and property schemas) is maintained in a spreadsheet https://docs.google.com/spreadsheets/d/1Wi7np8CooM0b3xPHZNd-iYst_DnKEo7FBswbnSXKoys/edit?gid=953290655#gid=953290655. The sheet is completely separated from the code and, unsurprisingly, out of sync.

      To ensure we have a single source of truth, we could take several approaches:

      • the tracking plan is maintained in a single place in the code
        • in the form of types, enforced by TS validation
        • in the form of e.g. JSON Schema, enforced by runtime validation (CI)
      • the tracking plan is automatically generated from the codebase, and
        • exported to github (compass repo, or devtools-internal-docs)
        • other export options?

            Assignee:
            maurizio.casimirri@mongodb.com Maurizio Casimirri
            Reporter:
            paula.stachova@mongodb.com Paula Stachova
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: