diff --git a/README.md b/README.md index 277ae0d2..6a132dea 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,44 @@ -# conda-dot-org +# Conda.org -This is the repository for the conda.org community website. To become involved: +Welcome to the repository for the Conda.org community website. This is the central hub for the Conda community and serves as a platform for sharing information, resources, and discussions related to Conda. -* Join the [conda.org chat room](https://app.element.io/#/room/#conda.org:matrix.org), which is part of the [conda space on Matrix](https://app.element.io/#/room/#conda:matrix.org) -* Visit the [Root HackMD page](https://hackmd.io/DGtozSlsSjSokpYAK5-9hw), which links to everything in HackMD. -* We meet every two weeks on Monday at 9am US Central time / 16:00 Central European Time. Please join the [Matrix room](https://app.element.io/#/room/#conda.org:matrix.org) and we will invite you. +## Getting involved -## Code of Conduct +To become involved with the Conda community and contribute to the website, there are a few steps you can follow: + +- Join the [conda.org chat room](https://app.element.io/#/room/#conda.org:matrix.org), which is part of the [conda space on Matrix](https://app.element.io/#/room/#conda:matrix.org) +- Visit the [Root HackMD page](https://hackmd.io/DGtozSlsSjSokpYAK5-9hw), which links to everything in HackMD. +- Attend our bi-weekly meetings, which are held on Mondays at 9am US Central time / 16:00 Central European Time. - - - Please join the [Matrix room](https://app.element.io/#/room/#conda.org:matrix.org) and we will invite you. -This repo and the web site it generates are governed by the [conda organization code of conduct](CODE_OF_CONDUCT.md). ## Implementation details +File Structure +```bash +src + ┣ components + ┃ ┣ Features + ┃ ┃ ┣ index.jsx + ┃ ┃ ┗ styles.module.css + ┃ ┣ Header + ┃ ┃ ┣ index.jsx + ┃ ┃ ┗ styles.module.css + ┃ ┣ News + ┃ ┃ ┣ index.jsx + ┃ ┃ ┗ styles.module.css + ┃ ┗ NewsCard + ┃ ┃ ┣ index.jsx + ┃ ┃ ┗ styles.module.css + ┣ css + ┃ ┗ custom.css + ┣ pages + ┃ ┣ community.md + ┃ ┣ index.jsx + ┃ ┣ index.module.css + ┃ ┗ style-guide.mdx + ┗ sidebars.js +``` + It is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. The contents are structured like this: @@ -27,10 +54,22 @@ contents are structured like this: - `package.json`: More configuration to install `docusaurus`. - `sidebars.js`: Support for sidebars. We use in automatic mode now. -> Non listed directories or files are generated automatically are not relevant for modifications. +- `.github/`: Workflows for deployment. +- `blog/`: Blog posts. Can use `.md` (Markdown), `.mdx` (Markdown with react) or `.js` extensions. Complex posts can use their own directory. +- `docs/`: Documentation with navigation and sidebars. +- `src/`: Resources (React components, custom CSS) and logic for standalone pages. +- `src/pages`: Standalone pages. This directory contains the homepage (`index.js`) and other simpler pages (`community.md`). +- `static/`: Static resources like images and icons. +- `babel.config.js`: Configuration to install `docusaurus`. +- `docusaurus.config.js`: Configuration for `docusaurus`. Includes variables like title and description, navigation menu items, etc. +- `package.json`: More configuration to install docusaurus. +- `sidebars.js`: Support for sidebars. We use automatic mode now. -## Local Development +> Please note that any non-listed directories or files are generated automatically and are not relevant for modifications. + +## Local Development +To run Conda.org on your local machine, follow these steps: ```bash $ git clone $ cd conda-dot-org @@ -38,10 +77,16 @@ $ npm install $ npm run start ``` -This command starts a local development server and opens up a browser window. -Most changes are reflected live without having to restart the server. +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. ## Deployment +Conda.org is deployed using [Netlify](https://www.netlify.com/). Once you are ready to deploy your changes, simply push them to the master branch and Netlify will automatically build and deploy the website. + +Thank you for your interest in contributing to the Conda community! + Deploys by Netlify +## Code of Conduct + +This repository and the website it generates are governed by the [conda organization code of conduct](CODE_OF_CONDUCT.md). We expect all contributors and participants in the Conda community to adhere to these guidelines and help maintain a welcoming and inclusive environment for all. \ No newline at end of file