summaryrefslogtreecommitdiff
path: root/mentoring
diff options
context:
space:
mode:
authorAlison Dowdney <alison@alisondowdney.com>2021-06-23 12:09:13 +0100
committerAlison Dowdney <alison@alisondowdney.com>2021-06-23 12:12:27 +0100
commitea804f0472b1cc5a400558365dee90808dbc54df (patch)
tree8c258b0e14259b824793785b7d89a0862380183c /mentoring
parent8c45b72d6999f52866795a2e9b8492bfbd415ba9 (diff)
UIncorporate feedback
Diffstat (limited to 'mentoring')
-rw-r--r--mentoring/programs/contributor-workshop/README.md2
-rw-r--r--mentoring/programs/contributor-workshop/resources/guides/README.md24
2 files changed, 16 insertions, 10 deletions
diff --git a/mentoring/programs/contributor-workshop/README.md b/mentoring/programs/contributor-workshop/README.md
index 535eee33..9199941d 100644
--- a/mentoring/programs/contributor-workshop/README.md
+++ b/mentoring/programs/contributor-workshop/README.md
@@ -12,7 +12,7 @@ The Contributor Workshop is currently in development, and has not been released
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/)
-The umbrella issue tracking getting this initiative available to the public is [#4830 in kubernetes/community](https://github.com/kubernetes/community/issues/4830).
+The umbrella issue tracking getting this initiative available to the public is [kubernetes/community#4830](https://github.com/kubernetes/community/issues/4830).
## Getting Involved
diff --git a/mentoring/programs/contributor-workshop/resources/guides/README.md b/mentoring/programs/contributor-workshop/resources/guides/README.md
index d0db193d..7280f8ac 100644
--- a/mentoring/programs/contributor-workshop/resources/guides/README.md
+++ b/mentoring/programs/contributor-workshop/resources/guides/README.md
@@ -8,9 +8,11 @@ This folder contains guides and information on how to contribute to the Contribu
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.
-Each of these segments contain
+Each of these segments contain:
+
* Written information
* One or more Exercises
+
and may contain a video version of the written information.
## Guides
@@ -25,11 +27,15 @@ How to structure, record, upload and update video guides associated with worksho
## Glossary of Terms
-Segment
- A page in the workshop directory covering a particular section of the Contributor Workshop.
- This page may contain
- * Written information
- * Video version of the segment
- * Hands on exercise
-Exercise
- Step by step, hands on activity within a segment. \ No newline at end of file
+### Segment
+
+A page in the workshop directory covering a particular section of the Contributor Workshop.
+This page may contain
+
+* Written information
+* Video version of the segment
+* Hands on exercise
+
+### Exercise
+
+A step by step, hands on activity within a segment.