Skip to content

Commit 3cf16a5

Browse files
committed
Revamp Contributor Workshop resources
In line with moving the contributor workshop to a self paced course, we need to provide resources on how to contribute and update the workshop. * Update the Video Guide * Create Guide on how to add segments to the workshop * Create a Glossary to define repeated verbalage * Outline how the workshop is structured * Create template for segments * Move exisitng resources for running live NCW to live-workshop
1 parent 3b2ee98 commit 3cf16a5

26 files changed

+588
-173
lines changed
Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
1-
# NCW Workshops
1+
# Contributor Workshop
22

3-
## Upcoming Workshops
3+
## Overview
44

5-
None scheduled
5+
The Contributor Workshop is a self paced course on the contributor site, aimed at both new and existing contributors.
66

7-
## Previous Workshops
7+
Previously this workshop was run as a live in person session, as part of the Kubernetes Contributor Summit. With many changes brought upon in 2020, we decided to change the format to a self paced course.
8+
9+
## Status
10+
11+
The Contributor Workshop is currently in development, and has not been released to the public.
12+
13+
You can view the live state of the site by going to [https://workshop--kubernetes-contributor.netlify.app/docs/workshop/](https://workshop--kubernetes-contributor.netlify.app/docs/workshop/)
14+
15+
The umbrella issue tracking getting this initiative available to the public is [#4830 in kubernetes/community](https://github.com/kubernetes/community/issues/4830).
16+
17+
## Getting Involved
18+
19+
* Read the guides on contributing to the Contributor Workshop
20+
[Contributing to the Contributor Workshop](resources/guides/README.md)
21+
22+
* Attend the bi-weekly mentoring meeting
23+
24+
* Join the discussion in #contributor-workshop-dev on Kubernetes Slack
25+
26+
## Previous Live Workshops
827
* [2019 NA Contributor Summit NCW](https://www.youtube.com/watch?v=uUJrGwAom-E&list=PL69nYSiGNLP0OWp38tPBc-jSlMmwWr6Ci&index=16) (Videos in playlist, links to first NCW video)
Lines changed: 4 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,6 @@
1-
# New Contributor Workshops Resources
1+
# Contributor Workshop Resources
22

3+
This folder contains information on
34

4-
## Overview
5-
6-
This folder contains the [handbook for the New Contributor Workshop Content Lead](./new-contributor-workshop-lead.md) as well as playbooks for each of the New Contributor Workshop sessions.
7-
8-
This workshop is held periodically by the Kubernetes Community, but materials and processes may be used at contributor focused summits and events anywhere.
9-
10-
Slides from previous New Contributor Workshops can be found [here](https://github.com/cncf/presentations/blob/master/kubernetes/README.md#kubernetes-new-contributor-workshops).
11-
12-
## Sample Track for Beginner Workshop
13-
14-
This workshop is meant for folks who have never contributed to opensource before and/or need help setting up a Kubernetes developer environment.
15-
16-
1. Welcome
17-
1. [Live PR Demo](./live-pr-demo.md)
18-
1. [Paths to Contributorship](./contributor-paths.md)
19-
1. [Communication in the Kubernetes Community](./how-we-communicate.md)
20-
1. [Community Group and Governance Overview](./community-groups.md)
21-
1. [Kubernetes Orgs Overview](./repo-tour.md)
22-
1. [Workspace Setup](./workspace-setup.md)
23-
1. [Local Build&Test](./build-and-test.md)
24-
1. [Pull Request Exercise](./playground-exercise.md)
25-
1. [Find Your First Issue](./first-issue-help.md)
26-
27-
## Sample Track for Intermediate Workshop
28-
29-
This workshop differs from the Beginner workshop in that participants are expected to have a working Docker/Kubernetes/Go setup. They have a basic understanding of how opensource contributions work, and may have opened a PR against Kubernetes before.
30-
31-
1. Welcome
32-
1. [Live PR Demo](./live-pr-demo.md)
33-
1. [Paths to Contributorship](./contributor-paths.md)
34-
1. [Communication in the Kubernetes Community](./how-we-communicate.md)
35-
1. [Community Group and Governance Overview](./community-groups.md)
36-
1. [Kubernetes Orgs Overview](./repo-tour.md)
37-
1. k/k Walkthrough
38-
1. [Local Build&Test](./build-and-test.md)
39-
1. [Labels, Bots and Git Workflow](./labels-and-bots.md)
40-
1. [Find Your First Issue](./first-issue-help.md)
5+
- How to contribute to the Contributor Workshop site
6+
- How to run a "live" Contributor Workshop (see [``live-workshop``](live-workshop/README.md))
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to the Contributor Workshop
2+
3+
## Overview
4+
5+
This folder contains guides and information on how to contribute to the Contributor Workshop.
6+
7+
## Workshop Structure
8+
9+
The workshop is divided into segments. These segments exist as individual pages in the ``content/en/docs/workshop`` directory on the branch ``workshop`` in the ``contributor-site`` repo.
10+
11+
Each of these segments contain
12+
* Written information
13+
* One or more Exercises
14+
and may contain a video version of the written information.
15+
16+
## Guides
17+
18+
### [Updating & Creating Segments](updating-segment.md)
19+
20+
How to update and create segments on the contributor site
21+
22+
### [Video Recording Guide for Contributor Workshop Segments](videoguide.md)
23+
24+
How to structure, record, upload and update video guides associated with workshop segments.
25+
26+
## Glossary of Terms
27+
28+
Segment
29+
A page in the workshop directory covering a particular section of the Contributor Workshop.
30+
This page may contain
31+
* Written information
32+
* Video version of the segment
33+
* Hands on exercise
34+
Exercise
35+
Step by step, hands on activity within a segment.
37 KB
Loading
51 KB
Loading
33.2 KB
Loading
623 KB
Loading
27.4 KB
Loading
235 KB
Loading
484 KB
Loading

0 commit comments

Comments
 (0)