From 8735020a1b48c34afa50b16a1b1daba1fd6ae272 Mon Sep 17 00:00:00 2001 From: guineveresaenger Date: Fri, 22 Nov 2019 20:24:23 -0800 Subject: [PATCH] add build and test and workspace setup --- .../new-contributor-workshops/README.md | 13 ++++----- .../build-and-test.md | 27 +++++++++++++++++++ .../workspace-setup.md | 24 +++++++++++++++++ 3 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 events/events-team/content/new-contributor-workshops/build-and-test.md create mode 100644 events/events-team/content/new-contributor-workshops/workspace-setup.md diff --git a/events/events-team/content/new-contributor-workshops/README.md b/events/events-team/content/new-contributor-workshops/README.md index 920fe4cab..5e9f0f83d 100644 --- a/events/events-team/content/new-contributor-workshops/README.md +++ b/events/events-team/content/new-contributor-workshops/README.md @@ -16,11 +16,11 @@ This workshop is meant for folks who have never contributed to opensource before 1. [Paths to Contributorship](./contributor-paths.md) 1. [Communication in the Kubernetes Community](./how-we-communicate.md) 1. [Community Group and Governance Overview](./community-groups.md) -1. Kubernetes Orgs Overview -1. Workspace Setup -1. Local Build&Test +1. [Kubernetes Orgs Overview](./repo-tour.md) +1. [Workspace Setup](./workspace-setup.md) +1. [Local Build&Test](./build-and-test.md) 1. Pull Request Exercise -1. Opensource Citizenship +1. Find Your First Issue 1. SIG Meet-and-Greet ## Sample Track for Intermediate Workshop @@ -32,8 +32,9 @@ This workshop differs from the Beginner workshop in that participants are expect 1. [Paths to Contributorship](./contributor-paths.md) 1. [Communication in the Kubernetes Community](./how-we-communicate.md) 1. [Community Group and Governance Overview](./community-groups.md) -1. Kubernetes Org Overview +1. [Kubernetes Orgs Overview](./repo-tour.md) 1. k/k Walkthrough -1. Local Build&Test +1. [Local Build&Test](./build-and-test.md) 1. Labels, Bots and Git Workflow +1. Find Your First Issue 1. SIG Meet-and-Greet \ No newline at end of file diff --git a/events/events-team/content/new-contributor-workshops/build-and-test.md b/events/events-team/content/new-contributor-workshops/build-and-test.md new file mode 100644 index 000000000..8ab873481 --- /dev/null +++ b/events/events-team/content/new-contributor-workshops/build-and-test.md @@ -0,0 +1,27 @@ +## Build and Test + +### Duration + +40-60 minutes, depending on beginner vs intermediate participants + +### Task Overview + +Build Kuberentes binaries locally, and do some fun things with them. + +**Important** Have facilitators to help with technical issues (2-3 is enough for Intermediate, you want 5 for Beginner) + +### Slides + +Clear command line instructions. + +### Details To Cover + +- This is the hands-on part. Details are up to you; look to previous workshops for inspiration. +- Adjust difficulty based on whether this is the Beginner or Intermediate workshop. +- It is _extremely important_ to run this part of the workshop several times previously, and to make sure that versions match those in the [workspace setup](./workspace-setup.md). + +### Ideas + +- Do a fun thing with the go client and a kind cluster +- Build and modify kubectl +- Try a `make` command; be aware you may need to give docker a lot of space on your machine for a successful build. \ No newline at end of file diff --git a/events/events-team/content/new-contributor-workshops/workspace-setup.md b/events/events-team/content/new-contributor-workshops/workspace-setup.md new file mode 100644 index 000000000..b21ba6a76 --- /dev/null +++ b/events/events-team/content/new-contributor-workshops/workspace-setup.md @@ -0,0 +1,24 @@ +## Workspace Setup + +### Duration + +Plan for 90- 120 minutes of download and setup time when on wifi. When on a workshop specific network, this may be much shortened. + +### Task Overview + +Make sure all Beginning Contributors have a workspace setup for hacking on Kubernetes. + +**Important** Have facilitators to help with technical issues (3-5 for ~30 people) + +### Slides + +Clear and large download commands to copy into terminal + +### Details To Cover + +- Make sure everyone has the correct setup for a local build and test demo. + +### Ideas + +- Have a dedicated workshop network. +- When internet is slow, start the download and prep process during earlier sessions, to make sure everyone is up to date.