Welcome to Virtual Coffee's Community Building Resources repository!
This repository contains documentation, procedures, and insights into how we manage various aspects of our tech community. Whether you're looking to understand how we operate and volunteer at Virtual Coffee, start your own community, or improve an existing one, we hope these resources will be valuable to you.
Visit the Virtual Coffee Community Building Resources website to start exploring!
Virtual Coffee's mission is to be a welcoming tech community that allows room for growth and mentorship at all levels and to create meaningful opportunities for learning, leadership, and contribution for everyone.
We prioritize supporting one another and believe in the power of learning and teaching at every level. To learn more about who we are, visit our website.
- Explore: Browse through the different folders in the
docsfolder to find areas of interest. - Learn: Each section contains documentation on how we approach different aspects of community building.
- Adapt: Feel free to use these resources as inspiration or templates for your own community initiatives, according to our license.
- Contribute: If you have suggestions or improvements, please open an issue or a discussion board post.
Important
If you'd like to make a change to this repo's docs, please make sure you've started with an issue or a discussion board post first and that you've been assigned to the issue. This allows the maintainer team to provide guidance and prioritize tasks. Otherwise, you may run the risk of spending time on something that doesn't end up getting accepted for various reasons.
Any changes to this repo need to be made via a pull request (PR).
Read our Contributors' Guide for more info about creating issues and PRs.
This site is built using Docusaurus. Follow the instructions in this section to set up your local environment.
Before starting, ensure you have Node version 22.0 or higher and the latest version of pnpm installed on your machine.
-
Fork the VC-Community-Docs repository to your own GitHub account.
-
Clone the forked repository to your local machine.
git clone https://github.com/YOUR-USERNAME/VC-Community-Docs.git
-
Navigate to and open the project in your code editor.
cd VC-Community-Docs -
Create a new branch to work on your changes. Do NOT work directly on the
mainbranch.git checkout -b YOUR-BRANCH-NAME
Replace "YOUR-BRANCH-NAME" with a descriptive name for your branch — for example,
feat/add-template. -
Install the dependencies and run the project.
Running the project locally is essential to see your changes in real time and test them thoroughly when you're contributing.
-
Install the dependencies and run the project locally
pnpm install pnpm start
-
Open the project at
http://localhost:3000/docson your browser after the local development server is ready -
Make and test changes
With the local server running, you can make changes to the files and immediately see the results in your browser. Test your changes thoroughly.
-
Stop the server
After completing and testing the changes, you can stop the local server by pressing
Ctrl + Cin the terminal.
If you have questions about our processes or want to discuss community building, feel free to open an issue or start a discussion in this repository. We're always happy to connect!
We hope these resources are helpful. Remember, every community is unique, so adapt these ideas to fit your specific needs and values. Happy community building!
We offer professional support, customization, and consulting services for this project. If you're interested in these services, please reach out to [email protected] for more information.
If you find this project useful and would like to support its development, consider becoming a sponsor through GitHub Sponsors.