Information | Link |
---|---|
Project | |
News | |
Chat | |
Build |
- Useful links 🔗
- Development setup 💻
- Working on the stylesheets/theme 🎨
- Contributing 🤝
- Contributors ✨
- License 📄
The Mentored Sprints Community Handbook is a collaborative handbook for organisers, mentors, and participants of open-source Contribution sprints. You're currently viewing the project GitHub repository where all the bits that make up the guide live, and where the process of writing/building the handbook happens.
This Handbook is created using Material for MKDocs and built and deployed using Netlify. To set up your development environment you'll need:
- Python > 3.7
- git
Once you have forked and cloned the repository you can go ahead and set your development environment. Follow these steps:
-
Create a virtual environment:
# first need to make sure we have everything installed python3 -m pip install --user virtualenv # this will create a .env directory at the root of your project python3 -m venv .env
-
Activate your environment
source .env/bin activate
-
Install dependencies:
$ python3 -m pip install -r requirements.txt
Once your dependencies are installed and within your activated environment you should be able to live serve the site using:
$ mkdocs serve
Then head to
http://127.0.0.1:8000/
in your browser to see the changes reflected as you work on the handbook.Once done you can stop the server by typing Ctrl + c in your terminal and deactivate your environment with:
deactivate
The stylesheets are located in .docs/stylesheets. As you work on them, you can compile them by typing in the terminal:
# adding the --watch will detect any chages and recompile the css
sass docs/stylesheets/custom.scss:docs/stylesheets/css/custom.css --watch
🚧 This repository is always a work in progress, and everyone is encouraged to help us build something useful to the many. 🚧
Everyone is asked to follow our Code of Conduct and to check out our Contributing Guidelines for more information on how to get started.
Thanks go to these wonderful people (emoji key):
Cheuk Ting Ho 📖 🤔 |
vfdev 🐛 |
Yashasvi Misra 📆 💻 |
Mukulika 🚧 |
Meeka 🚧 |
trangology 💻 |
Anita Tran 💻 |
This project follows the all-contributors specification. Contributions of any kind are welcome!
The code for this site is Licensed as BSD-3 and the content is licensed as CC-BY 4.0 ⓒMentored Sprints.