https://github.com/conda-forge/conda-forge.github.io

The conda-forge website.
https://github.com/conda-forge/conda-forge.github.io

conda-forge docs

Last synced: 7 months ago
JSON representation

The conda-forge website.

• Host: GitHub
• URL: https://github.com/conda-forge/conda-forge.github.io
• Owner: conda-forge
• License: bsd-3-clause
• Created: 2015-07-12T13:22:31.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T20:54:27.000Z (11 months ago)
• Last Synced: 2024-10-30T01:56:11.905Z (11 months ago)
• Topics: conda-forge, docs
• Language: JavaScript
• Homepage: https://conda-forge.org
• Size: 240 MB
• Stars: 131
• Watchers: 36
• Forks: 274
• Open Issues: 354
• Metadata Files:
  • Readme: README.md
  • Changelog: news/2018-09-10-conda-forge-now-has-a-magical-status-bar-for-tracking-the-progress-of-migrations.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# [conda-forge.org](https://conda-forge.org)

[![deploy](https://github.com/conda-forge/conda-forge.github.io/workflows/deploy/badge.svg)](https://github.com/conda-forge/conda-forge.github.io/actions?query=workflow%3Adeploy)

## Overview

This repository

- is the home of the source code of conda-forge's documentation.

- is the home of the source code of conda-forge's [status dashboard](src/components/StatusDashboard/README.md).

- provides an [issue tracker](https://github.com/conda-forge/conda-forge.github.io/issues) 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](https://conda-forge.org/docs/user/how_to_get_help.html).

## Improving the docs

- You can help to improve the documentation! It is version-controlled in the [conda-forge.github.io repository on GitHub](https://github.com/conda-forge/conda-forge.github.io).

- 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:

1.  [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [conda-forge.github.io](https://github.com/conda-forge/conda-forge.github.io) repository to your own GitHub user account.

2.  [Clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) this fork onto your computer.

3.  Go into the main folder.

    Run the following commands.

    - `conda env create -f ./.ci_scripts/environment.yml`

    - `conda activate conda-forge-docs`

    - For live builds, `npm install && npm run start`

    - For production builds, run `.ci_scripts/update_docs`

4.  Make and commit your changes.

5.  Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) to the main repository proposing your changes.

## Code of conduct

We at conda-forge adhere to the [NumFOCUS Code of Conduct](https://numfocus.org/code-of-conduct):

> - Be kind to others. Do not insult or put down others. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate for conda-forge.

> - All communication should be appropriate for a professional audience, including people of many different backgrounds. Sexual language and imagery is not appropriate.

> - conda-forge is dedicated to providing a harassment-free community for everyone, regardless of gender, sexual orientation, gender identity and expression, disability, physical appearance, body size, race, or religion. We do not tolerate harassment of community members in any form.

Thank you for helping make this a welcoming, friendly community for all.

### Reporting guidelines

If you believe someone is violating the code of conduct, please report this in a timely manner. Code of conduct violations reduce the value of the community for everyone. The team at conda-forge takes reports of misconduct very seriously and is committed to preserving and maintaining the welcoming nature of our community.

Reports should be sent to , a private mailing list only accessible by the members of the core team. If your report involves a member of the core team, please send it to NumFOCUS following [these instructions](https://numfocus.org/code-of-conduct#how-to-report).

All reports will be kept confidential. Please have a look at the [Reporting guidelines](https://numfocus.org/code-of-conduct#reporting-guidelines).

### Enforcement: What happens after a report is filed?

conda-forge's team and/or our event staff will try to ensure your safety and help with any immediate needs, particularly at an in-person event. Once we have received the report through the relevant authorities, conda-forge will make every effort to acknowledge the receipt and take action. Have a look at the process of [What Happens After a Report is Filed?](https://numfocus.org/code-of-conduct#enforcement).

## conda-forge meetings

Refer to our [Community > Meeting minutes](https://conda-forge.org/community/minutes/) page.