Fixing file names and adding @CathPag's how-to. (kubernetes#51)

* Fixing file names and adding @CathPag's how-to. * typo Co-authored-by: Mike Foster <[email protected]>
Okabe-Junya · Feb 26, 2021 · eb96bbc · eb96bbc
1 parent 2a8d66a
commit eb96bbc
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/how-to.md b/how-to.md
@@ -0,0 +1,44 @@
+# How to navigate this GitHub page and submit a PR
+## The landing page
+The landing page can be found on github.com/cncf/glossary. The most important sections are:
+- **Definitions:** all definitions that are part of the glossary in separate files, including a template for new terms,
+- **Contributing:** info about the project, how to contribute, and project guidelines,
+- **Persona:** the persona this glossary is targeting,
+- **Style guide:** format and style of glossary entries.
+
+![landing](images/how-to/1.png)
+
+## Navigate the page using the tabs
+To navigate this page, use the tabs. Most relevant to you are:
+- **Issues:** tasks that have been flagged and help is needed,
+- **Pull requests (PR):** once you created a pull request is should appear here (more to PRs below),
+- **Discussions:** where conversations about the project take place. You can participate or start a new one.
+
+![tabs](images/how-to/2.png)
+
+## Issues
+In the "issues" tab, you'll find current open issues. Issues are tasks that have been identified. Most relevant to you are those with a "good first issue" or "help wanted" tag. Some have already been assigned to people (see arrows). 
+
+![issues](images/how-to/3.png)
+
+Before getting started, make sure someone else didn't "claim" that issue already. Click on the issue to learn more about it. In this case, someone already claimed the container image term, so pick a different issue.
+
+![claims](images/how-to/4.png)
+
+# Updating a glossary term (aka submitting a PR)
+Now, let's update a glossary entry. Go to the [definitions page:](https://github.com/cncf/glossary/tree/main/definitions)
+1. Select your term
+2. Click on edit
+3. Update the term
+4. Create a new branch 
+5. Create a pull request
+
+Check out this screen recording:
+
+![rec](images/how-to/screenRec.gif)
+
+After successfully submitting your PR, you should see it here:
+
+![success](images/how-to/5.png)
+
+Didn't work? Please reach out on Slack in the marketing-business-value channel. We'll be happy to help! 
diff --git a/images/how-to/sc1.png → images/how-to/1.png b/images/how-to/sc1.png → images/how-to/1.png