When contributing to this CarpentryConnect Website repository, please first discuss the change you wish to make with this repository's maintainers via this repository's issue tracker or email before dedicating time to make big, time-consuming changes.
Is anything missing from this first version of our CarpentryConnect Planning Kit? Email community@carpentries.org or open an issue on the CarpentryConnect Planning Kit repository on GitHub and we will work together to improve the resource. Community contributions are also welcome. You can find sections to contribute to, and information on how to start contributing in the contributing section of the CarpentryConnect Planning Kit.
About the Code Base
This resource is a Jekyll website.
Here’s how content is organised on the website:
Markdown files
Files for pages available in the menu bar at the top of the website are available in the root folder i.e.
- index.markdown
- in-person.markdown
- online.markdown
- case-studies.markdown
- CONTRIBUTING.md
Stylesheet
All associated styling that makes pages in this resource readable and aesthetically pleasing can be found in the css folder.
YAML files
YAML files are a human-readable way to feed data into our website.
- _config.yml holds information about navigation settings.
Be careful about spacing when working with YAML files. When in doubt / experiencing errors, use a linter service like YAMLlint to validate your additions.
Image Files
All image files are in the img folder.
Setting Up a Local Instance
Should you wish to make changes locally, and review them before submitting a Pull Request, here’s how to go about it:
-
Open your local terminal and clone this repository
-
Install Bundler. If you like, you can learn more about bundler.
gem install bundler
- Navigate to your root folder and run the command
bundle install
This looks at your GEMFILE and installs all ruby gems listed in it.
- Run Jekyll
bundle exec jekyll serve
Where to Find Help
Submit an Issue
We welcome any questions you may have about setting up or contributing to this website repository in the issues section of this repository.
Email us
Where email is preferred, you can reach out to us on community@carpentries.org.