conda-forge / conda-forge/conda-forge.github.io

Proposal to Add flowchart and diagram to Documentation

Open
#2,000 2 comments 0 reactions 0 assignees View on GitHub
Docs enhancement
Dominant language
JavaScript
Stars
170
Forks
320
Avg merge
2d 10h
Merged PRs (30d)
5

Description

### 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_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.