Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 1.13 KB

Contributing

Using the Template

This template project https://github.com/equinix-labs/equinix-labs-workshop is used for creating consistent workshop experiences on Equinix Labs.

To create a new workshop, use the "Use this template" button on the project. Once you have your new project created, follow these steps:

  1. Search and replace "equinix-labs-workshop" with the name of the GitHub repo you created when using the template.
  2. Search and replace "Workshop: Equinix Labs" with the name of your workshop.
  3. You'll want to enable GitHub Pages for the project:
  4. Update docs/index.md, the docs/part*.md files, and the markdown below for your workshop.
  5. Remove this "Using the Template" section.

Previewing Changes

pip install mkdocs mkdocs-material mkdocs-glightbox
mkdocs serve

Publishing Changes

This project is published to GitHub Pages using GitHub Actions upon merge.