This repository
- is the home of the source code of conda-forge's documentation.
- provides an issue tracker for conda-forge related questions and issues that are not specific to individual feedstocks.
If you have questions or need help, please check out our documentation for a list of ways to interact with us.
-
You can help to improve the documentation! It is version-controlled in the conda-forge.github.io repository on GitHub. The source text is stored in the src/ subdirectory and is formatted using Python’s reStructuredText system.
-
The docs are built on GitHub Actions and run the
.ci_scripts/update_docs
script. We are glad to know that you would like to contribute. To build the docs locally, follow the steps mentioned below:
- Fork the conda-forge.github.io repository to your own GitHub user account.
- Clone this fork onto your computer.
- Go into the main folder.
Run the following commands.conda env create -f ./.ci_scripts/environment.yml
conda activate conda-forge-docs
cd newsfeed && pip install --no-deps .
cd ../src
make html
- Make and commit your changes.
- Submit a pull request to the main repository proposing your changes.
Note: "All changes must be made in the /src
folder and NOT in the /docs
folder. Html files in the ./docs folder are auto generated "
Our documentation contains a section with minutes from previous dev meetings. These meetings occur every two weeks on Wednesday from 17:00-18:00 UTC. A link to the google calendar item can be found here.
We use https://hackmd.io/ for taking meeting minutes and will upload the resultant markdown file after the meeting has concluded.
There is a template provided in misc/DEV_MEETING_TEMPLATE.md
that you should use to create a new hackmd document.