FY23Q4 TW OKR: Expand "Learn GitLab with Tutorials" for growing number of new users => 92%
In a previous OKR, we added the Tutorials page to the GitLab docs.
For the next iteration, we plan to:
- Revise the Tutorials page and ensure all existing links are still relevant (
@kpaizee
). - Identify new tutorial topics for high-impact areas of the GitLab product. (TW team)
Identify at least one topic for a tutorial
Identify a topic/subject in your assigned areas that could use a tutorial. Keep the following in mind:
- Of your assigned groups, pick one that has the highest page views (use Writer pages to get an idea), or is a mature, high-impact area of the product.
- Beginner-level content is ideal, as we want to help the growing number of new users in GitLab.
- Consider a topic that can fit into the Use GitLab section of the left navigation. This section accounts for the most page views in our docs. If your assigned groups don't fall into this section of the nav, that's fine.
- A tutorial is end-to-end workflow that helps users achieve a specific outcome. It's task-based, so avoid topics that require conceptual discussion.
- The workflow can span features across multiple groups. It does not have to be limited to the features in your group.
If needed, work with your PMs to identify a suitable topic for a tutorial.
You might have an existing documentation issue in your backlog (or in your group's backlog) that includes a suggestion for an appropriate tutorial. If so, follow the next steps to refine the issue.
Create an issue for your tutorial topic
- Create a new issue in the
gitlab
project with the titleDocs tutorial: <name of topic>
. - Add appropriate group labels, and the following:
~documentation ~"docs-only" ~"docs::improvement" ~"type::maintenance" ~"maintenance::refactor" ~"Technical Writing"
- Set the milestone to
backlog
. - In the description, explain:
- The goal of the tutorial.
- The basic outline of the steps to document.
- A suggestion of where to place this tutorial in the left navigation.
- Example issue: gitlab#378206 (closed)
- Add the issue to the tutorials roadmap epic. You do not have to write the tutorial for this OKR.
- Add the issue to the table below.
- If you have more than one idea for a tutorial, create and add as many issues as needed.
Tech writer | Issue | Notes |
---|---|---|
Amy | gitlab#387232 | Page already exists, but is not in good shape. |
Ashraf |
gitlab#385742 gitlab#385743 |
|
Axil | ||
Clayton | gitlab#349764 (closed) and gitlab#349768 (closed) | Lyn Landon has several tutorials on-the-go for Security Policies based on https://tanuki-workshops.gitlab.io/secure-demos/tutorials/dependency_scanning/ |
Evan | gitlab#388528 | Take a page already linked to from the tutorials page, and make it more like a tutorial with the structure from the tutorials template. |
Fiona | gitlab#387640 (closed) | |
Lorena |
gitlab#385286 gitlab#385281 (closed) |
|
Jon |
383255 383583 |
|
Marcel | gitlab#389812 (closed) | Write a full real pipeline, from scratch, using all the most-used keywords. |
Marcin | gitlab#389581 (closed) | Take an existing topic from the issue boards doc and make it more like a tutorial with the structure from the tutorials template. |
Phillip | gitlab#389934 (closed) | An existing page already exists, but needs to be rewritten and patched up with additional content. |
Russell | 389519 |
Completed tasks
- Amy
-
Issue created.
-
- Ashraf
-
Issue created.
-
- Axil
-
Issue created.
-
- Clayton
-
Issue created.
-
- Evan
-
Issue created.
-
- Fiona
-
Issue created.
-
- Kati
-
Tutorials page revised and outdated links removed or updated.
-
- Lorena
-
Issue created.
-
- Jon
-
Issue created.
-
- Marcel
-
Issue created.
-
- Marcin
-
Issue created.
-
- Phillip
-
Issue created.
-
- Russell
-
Issue created.
-
Edited by Phillip Wells