search

conda-forge / conda-forge.github.io

The conda-forge website.
https://conda-forge.org
BSD 3-Clause "New" or "Revised" License
131 stars 274 forks source link

Proposal to Add flowchart and diagram to Documentation #2000

Open mhmohona opened 1 year ago

mhmohona commented 1 year ago

Where should the content be added?

No response

What should be added?

As a user to conda-forge, I believe that adding visual aids such as diagrams and flowcharts to the documentation could significantly improve its readability and user-friendliness.

Here are a few areas where I think diagrams could be particularly useful:

  1. About conda-forge: A diagram illustrating the relationship between the different entities such as Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI, and how they interact to build and upload installable packages to the conda-forge channel.

  2. Package Building Process: This flowchart can illustrate the step-by-step process of building a package, starting from the creation of a feedstock to the final uploading of the package to the conda-forge channel. This can be particularly useful for new contributors who are not yet familiar with the process.

  3. Package Installation Process: A flowchart guiding users through the process of installing a package from the conda-forge channel.

  4. Updating diagrams-feedstock: A diagram illustrating the process of improving the diagrams recipe or building a new package version, including forking the repository, submitting a PR, reviewing the changes, merging the PR, and uploading the conda packages to the conda-forge channel.

  5. Conda-forge Ecosystem: This flowchart can provide an overview of the conda-forge ecosystem and how different components interact with each other. It can include elements like different repositories, continuous integration services, and the conda-forge channel.

I would be happy to work on creating these diagrams if the idea is approved.

Additional information

No response

jaimergp commented 1 year ago

There's some ongoing work at https://cf-infra-docs.netlify.app/docs/advanced/automation/, as well as PRs in this repo (#1245).

This usually requires plenty of in-depth knowledge about how conda-forge is set up so it's not trivial. Let me know what you think of the existing work and we can iterate from there.

mhmohona commented 1 year ago

Diagrams in both places are great. Just one thing is it would be better if these diagram could be simplified. However as its advanced topic, I understand it's overwhelmingness.

I would love to dig down deeper.