Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.7 KB

updating-segment.md

File metadata and controls

60 lines (38 loc) · 2.7 KB

Updating workshop segments

This guide covers how to update segments in the Contributor Workshop.

Prerequisites

Fork & Clone the contributor-site

Create a fork of the contributor-site repo.

Clone your fork locally

Checkout a branch off the workshop branch for your changes

git remote add upstream [email protected]:kubernetes/contributor-site.git
git remote set-url --push upstream no_push
git fetch upstream
git checkout workshop
git rebase upstream/workshop
git checkout <your feature branch>

Run the site locally with your changes

Follow the instructions in the top level README.md on the contributor-site.

You're now ready to update and add segments!

Modifying an existing segment

Find the file you would like to edit and open it. See the list of segments.

Adding a segment to the workshop

Make sure to update the list of segments, with the new page.

If inserting a page between existing pages, make sure to update the page weightings in the frontmatter and the list of segments,.

See the segment template, on how to structure your segment.

Adding a video guide to accompany a segment

With some of the guides, we might want a youtube video to accompany them. You can find the information for adding a video to the guide, in the video guide

Save, Commit, Push, PR

Once you've made the modifications and additions you want, commit and push them to your fork.

Then make a pull request of your changes into the workshop branch of the contributor-site repo.