Comments (6)
- Started using diagrams to generate CF bot's components diagrams
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.
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.
Related Issues (20)
- Add OCI registry support in conda/mamba
- OCI-Quetz integrations
- Finalize oras-py implementation HOT 2
- Choose / create repository to store WIP documentation HOT 3
- Upstream contributions related to security
- ENH - Project management
- Document existing infrastructure HOT 3
- Create a "basic" inventory of `conda-forge` resources and owners
- Document security model
- Improve infrastructure diagrams HOT 4
- Client-side access to anaconda.org-provided .conda metadata in conda-forge.org/packages HOT 1
- Publicize conda-metadata-app through the conda-forge.org/packages page HOT 1
- Serve Python import maps outside libcfgraph HOT 1
- Files-to-artifacts database / API / mapping HOT 4
- Migrate content from cf-infra-docs to conda-forge.org (maybe iteratively) HOT 6
- Compile an audit report with suggestions and best practices
- Git-based files-to-artifacts database deployment prototype HOT 2
- Sqlite-based files-to-artifacts database deployment HOT 5
- Document used services and who has access to each one HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from czi-conda-forge-mgmt.