2c8894dd347b158fc04b5ad80059b4357927498a
\353\260\225\353\217\231\355\235\254.md
| ... | ... | @@ -22,9 +22,11 @@ https://dh8.kr |
| 22 | 22 | {:.no_toc .hidden-md .hidden-lg} |
| 23 | 23 | - TOC |
| 24 | 24 | {:toc .hidden-md .hidden-lg} |
| 25 | + |
|
| 25 | 26 | ## Welcome to the Practical Handbook Edits Examples Page |
| 26 | 27 | This page contains video recordings and written tips for non-engineering team members on how to work Handbook-First. In these videos, we run through the GitLab Handbook with experts, uncovering how to best use the Handbook in our day-to-day work, and learning best-practices for Handbook editing along the way. This page is intended to be complementary to [Using GitLab at GitLab](/handbook/using-gitlab-at-gitlab/#using-gitlab-competency), and we suggest you start there if you have not yet completed the [GitLab 101 Tool Certification](/handbook/people-group/learning-and-development/certifications/gitlab-101/). |
| 27 | 28 | **Have your own practical Handbook editing tips? Drop a video below!** |
| 29 | + |
|
| 28 | 30 | ### Creating new handbook pages and multimedia embedding best-practices |
| 29 | 31 | <figure class="video_container"> |
| 30 | 32 | <iframe src="https://www.youtube.com/embed/hQgS97M8abc" frameborder="0" allowfullscreen="true"> </iframe> |
| ... | ... | @@ -43,6 +45,7 @@ This video covers: |
| 43 | 45 | - Renaming a URL - @1:05 |
| 44 | 46 | - Redirecting from one URL to the other - @2:17 |
| 45 | 47 | - Finding places where an old URL is linked and updating it to a new URL - @ 4:30 |
| 48 | + |
|
| 46 | 49 | ### Creating mermaid diagrams |
| 47 | 50 | <figure class="video_container"> |
| 48 | 51 | <iframe src="https://www.youtube.com/embed/SQ9QmuTHuSI" frameborder="0" allowfullscreen="true"> </iframe> |
| ... | ... | @@ -52,6 +55,7 @@ This video covers: |
| 52 | 55 | - Intro to a mermaid diagram |
| 53 | 56 | - What they look like |
| 54 | 57 | - Use cases for using them in the handbook |
| 58 | + |
|
| 55 | 59 | ### Creating issue templates |
| 56 | 60 | <figure class="video_container"> |
| 57 | 61 | <iframe src="https://www.youtube.com/embed/ObNWS3trqIY" frameborder="0" allowfullscreen="true"> </iframe> |
| ... | ... | @@ -60,6 +64,7 @@ This video covers: |
| 60 | 64 | - Why you may want to use issue templates - @0:10 |
| 61 | 65 | - What is an issue template and how to create one - @:54 |
| 62 | 66 | - How issue templates and boards facilitate workflow management and automation - @3:55 |
| 67 | + |
|
| 63 | 68 | ### Adding images to the handbook and handbook analytics |
| 64 | 69 | <figure class="video_container"> |
| 65 | 70 | <iframe src="https://www.youtube.com/embed/P7Nv7bzksiY" frameborder="0" allowfullscreen="true"> </iframe> |
| ... | ... | @@ -75,6 +80,7 @@ This video covers: |
| 75 | 80 | </figure> |
| 76 | 81 | This video covers: |
| 77 | 82 | - How to add a new page to your section of the handbook complete with a new main page and table of contents |
| 83 | + |
|
| 78 | 84 | ### Updating individual team member YAML for managerial changes |
| 79 | 85 | Every GitLab team member has an entry in [team_members/person](https://gitlab.com/gitlab-com/www-gitlab-com/-/tree/master/data/team_members/person) and when a new manager joins a team, updates are needed in three places: |
| 80 | 86 | - Manager's entry - Update job family |