Skip to content

FY24Q2 TW KR: Write tutorials to provide how-to information to new GitLab users => 82%

KR to update for % complete

In a previous KR, we started writing or refining tutorials for high-impact areas of our docs.

For this KR, we'll continue to write new, or refine existing tutorial topics for high-impact areas of the GitLab product, and add them to the Learn GitLab with Tutorials page.

You only need to write one tutorial this quarter.

Steps to write a tutorial

  1. Identify a tutorial topic to work on. If you don't have an idea in mind:
    • The tutorials roadmap epic has linked tutorial issues that were identified in previous KRs.
    • Ask @sselhorn for an idea for a tutorial in your area.
    • Remember that beginner-level content is ideal, as we want to help the growing number of new users in GitLab.
  2. Add the working title to the table.
  3. Give your technical reviewers an early heads up that you'll need their input for a review.
  4. Create a draft MR and request a technical review from a developer and/or PM.
  5. When the technical review is complete, request a Technical Writing review from Kati or Diana as follows:
    • Kati: Amy, Axil, Marcel, Russell, Fiona, Marcin
    • Diana: Lorena, Phillip, Catherine, Ashraf, Jon, Evan
  6. After the tutorial MR is merged, open an MR for a left nav entry.
  7. Optional. Add a link to the tutorial on one of the Learn GitLab with tutorials pages, if it's appropriate for any of those pages.

Get help at any point by mentioning @kpaizee, @sselhorn, or @dianalogan. The tutorial does not have to be perfect. You can iterate after it's merged.

Resources

Tutorial topics

Tech writer Issue/notes Working title of the tutorial MRs
Amy Create a protected workflow gitlab!123872 (merged), gitlab-docs!4064 (merged) gitlab!127086 (merged)
Ashraf Create Jira credentials gitlab!119735 (merged), gitlab!121638 (merged), gitlab-docs!3898 (merged), gitlab!122197 (merged)
Axil gitlab#408328 (closed) Install a single node instance using the Linux package and configure it to be secure gitlab!125326 (merged)
Catherine gitlab#409489 (closed) Build, test, and deploy your Hugo site with GitLab Pages gitlab!121150 (merged), gitlab!122077 (merged), gitlab-docs!3892 (merged)
Evan Complete gitlab!110119 (closed) Scan a Docker container for vulnerabilities gitlab!122587 (merged), gitlab-docs!3961 (merged)
Fiona GitLab Runner beginner tutorial: Create and run... (gitlab#415064 - closed) Create and run your first runner gitlab!125119 (merged)
Jon Set up your organization gitlab!118662 (merged)
Lorena Tutorial: Set up a website project with analytics (gitlab#418242 - closed) Set up an analytics-powered website project gitlab!126523 (merged), gitlab-docs!4137 (merged)
Marcel Create a CI/CD Catalog component How to update Git commit messages gitlab!127609 (merged) (Missed deadline) gitlab-docs!4133 (merged)
Marcin Docs tutorial: How to do issue triage in GitLab (gitlab#376194) Set up GitLab for issue triage gitlab!126384 (merged)
Phillip Docs tutorial: Structure GitOps repository (gitlab#389934 - closed) Structure your repository for GitOps deployments / Deploy an OCI artifact using Flux gitlab!123116 (merged)
Russell Created Dependency Scanning tutorial (gitlab!109928 - merged) Set up dependency scanning Created Dependency Scanning tutorial (gitlab!109928 - merged)

Completed tasks

  • Amy
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Ashraf
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Axil
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Catherine
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Evan
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Fiona
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Jon
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Lorena
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Marcel
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Marcin
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Phillip
    • Tutorial topic identified, working title added to table
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
  • Russell
    • First draft in technical review
    • MVC tutorial merged, left nav updated
    • Added to Learn GitLab page (or considered)
Edited by Lorena Ciutacu