feature request: document harmonized index schema, and update it on demand

[pepopowitz]

Originally discussed in slack. Requested by @ChrisKujawa.

We would like to document our new harmonized index¹ structure and make this more consumable by users (in general to have something in our docs about it).

Based on the input I understood it would be great to have something similar to what we have for C7 (ER diagrams) .

Be aware the indices schemas are in JSON and can be found here. Ideally, we have something automated (maybe we can brainstorm on this). I did a small research on this and it seems to be possible to either generate images out of JSON or simply generate tables via JS.

Implementation notes

• Mermaid may be a good format for emitting these diagrams.
• We should use the sync workflow for the c8 REST api docs as an example of pulling a spec from another repo, executing a transformation, and opening a PR for review.
• The transformation itself is the most uncertain part of this process. How can we map the JSON index specs into Mermaid diagrams that are useful? What should the diagrams look like? etc.

Footnotes

1. the harmonized index schema refers to indices that are created and used by the Camunda platform (core) starting with 8.7. See this document for more details. ↩