Create preliminar Infrastructure diagrams about czi-conda-forge-mgmt HOT 6 CLOSED

• Started using diagrams to generate CF bot's components diagrams
  • a brief comparison using javascript-based diagram Mermaid tooling x a python-based one, Diagrams.
  • Adapt previous docs/graphs/diagrams into the new doc's structural design (Nan)

from czi-conda-forge-mgmt.

After pondering those two approaches, I've decided that Mermaid seems to be the best use case for our docs. The reason can be outlined into two main points:

• The general graph coding experience (layout/classes) is similar to Diagrams, which makes its use quite simple to structure new graphs or add modifications to existing ones
• Docssauros has a built-in (needs import) plugging for including mermaid diagrams direct in markdown files without much trouble. Compared with Diagrams, it is easier to handle, build (no need to run extra commands), and modify in the future.

from czi-conda-forge-mgmt.

As of now, to reduce the spent time on getting our diagram in the mermaid format, we will be using LucidCharts to generate the structure of these, for initial review and iterations, and later import into the docs with the proper formating/code

from czi-conda-forge-mgmt.

Current iteration

from czi-conda-forge-mgmt.

Here we have come key concepts described using different colors:

• Agents/actors (red)
• Objects (greem)
• Verbs (purple-ish)
  which still lack a proper definition, but its idea is to better organize the different situations and functionality of conda-forge infrastructure into classes of objects that sometimes interact with other resources (usually modifying some integral part of it), the agents/actors, or the object that receive such interactions "the objects."

Such classification helps outline the different scenarios with which the same object/actor might be involved and the extra level of coordination/management/authority that the same object controls.

• Identified above the core concept is definitely the feedstock, wich in the next iteration will become the center part of the next diagrams in a more easy to read/follow representation

from czi-conda-forge-mgmt.

I merged the current status to get us going but we need to revisit the diagrams in the future. I'll create a separate issue for that.

from czi-conda-forge-mgmt.