Skip to content

Files

Latest commit

 

History

History
42 lines (26 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.13 KB

Contributing

First of all, thanks for even considering contributing to this project. It will work best with a diverse perspective of voices and experiences!

How to run the site locally

To run the site locally, you will need these tools installed:

  • NodeJS (version: lts/hydrogen)

site-content directory

This directory houses all of the content of the site, and is primarily where you'll want to do your work.

cd site-content

Install dependencies

npm install

Start the site locally

npm start

This will start a local server at http://localhost:3000/ which will auto-reload when you make changes to the site files.

Project structure

site-content directory

This directory houses all of the content of the site, and is primarily where you'll want to do your work.

  • src/assets: Stores image assets used in the guides
  • src/content/docs/ci: Guides about Continuous Integration
  • src/content/docs/languages: Guides assembled from snippets concerning languages
  • src/content/docs/providers: Guides assembled from snippets concerning CI/CD providers