README.md

https://mentored-sprints.dev

🔗 Useful links

Information	Link
Project
News
Chat
Build

• 🔗 Useful links
• 💻 Development
  • Running this Site Locally
  • 📝 Adding content to the site
    • 📆 Events
    • 📝 Website section
  • 📖 Style-guide
    • 🎨 Colours
    • 🔖 Section colours
• 🙌 Contributing
• 📖 License

This repository contains the source code for https://mentored-sprints.dev, which is the main website for this community project.

If you are looking for the source for the Community Handbook, head to https://github.com/pycon-mentored-sprints/community-handbook.

💻 Development

Running this Site Locally

This website is build using Jekyll and served through Netlify. If you want to make changes to the site, follow these steps to work on this on your local computer.

1. Install a full Ruby development environment

2. Install Jekyll and Bundler

    gem install jekyll bundler
   

3. Install dependencies from Gemfile:

    bundle install
   

4. Build the site and make it available on a local server

    bundle exec jekyll serve
   

5. Browse to http://localhost:4000

📝 Adding content to the site

📆 Events

1. Clone the project and make a new branch event/event-name

2. Make a copy of the event template and place it in the events directory. Make sure to name it following this pattern <event-name>-<event-date-YY-mm-dd>.

3. Fill in the event metadata:

---
title: Your event name
excerpt: >-
  Text to be displayed in the preview. Make it catchy and descriptive
# note this is the date for the event, not when the post is published
date: '2020-10-15'
# add images to images/events and update the path here. You can use the same image for the thumb and the main image on the post
thumb_image: images/hacktoberfest-folks.jpg
image: images/hacktoberfest-folks.jpg
# Uncomment this if you have registration open, for example, or if you have a call to action
# actions:
#   text: Registration for attendees is now open!
#   url: https://github.com
#   action: Click here
#   background: accent
#   aria: description for screen readers
# do not modify the layout
layout: event
---

⚠️ Place any images in the ./images/events directory to keep things tidy.

We have added an actions label which can be used to add calls for action such as registration and the such. Uncomment the section and fill in the details:

• Text: call for action Text
• URL: which URL should folks be redirected to (e.g. Eventbrite, Pretix)
• action: the text for the action button
• background: any of the background styles (see Style guide and Section colours for an example image)

Using the template ensures your event is added to the Events section and sorted by date.

Once completed:

1. Save and commit your changes
2. Push your changes and create a pull request

📝 Website section

To add a new section to the main page.

1. Clone the project and make a new branch content/<whatever>
2. Open ./index.md
3. Add your section where needed:

- section_id: upcoming_events
 type: section_features
 background: white
 title: Upcoming Events
 subtitle: >-
   Find when the next mentored sprints event is
 features:
   - title: Hacktoberfest 2020
     image: images/wocintech1.jpg
     content: >-
       Let's celebrate Hacktoberfest together! Join folks from Kedro, Terminus DB and Rasa.
     actions:
       - label: Learn More
         url: /events
         primary: true
         aria: description for screen readers

• section_id: make sure this is unique to the section
• background: see style guide
• actions: similar to events, this adds a call to action, make sure the URL exists e.g. if redirecting to a new page in the site, there has to be a corresponding .md file.
• aria: to make the content more accessible for screen readers provide a descriptive label for example: Register to our PyCon Mentored Sprints (For context read this article on making links more acecssible).

Once completed:

1. Save and commit your changes
2. Push your changes and create a pull request

📖 Style-guide

🎨 Colours

The colours used in the site derive from the Mentored Sprints brand colours, but we optimised for web and accessibility:

Name - theme reference	COLOUR HEX CODE
Light Wisteria - primary	#ce89ce
Slate blue -secondary	#5B63CE
Midle Blue Green -accent	#8DDDD2
Raisin black - dark	#1B212F
Ghost white - white	#F8F9FF

🔖 Section colours

The sections in the website can take any of the website colours: dark, accent, primary, secondary, or white.

For events, these are specified in the YAML header:

actions:
  text: Registration for attendees is now open!
  url: https://github.com
  action: Click here
  background: accent
  aria: description for screen readers

and are rendered as:

🙌 Contributing

🚧 This repository is always a work in progress. And everyone is encouraged to help us build something useful to the many. 🚧

Everyone should follow our Code of Conduct and check out our Contributing Guidelines for more information on how to get started.

📖 License

The code for this site is Licensed as BSD-3 and the content is licensed as CC-BY 4.0 ⓒMentored Sprints.