Commit 22b984c6 authored by Evan Read's avatar Evan Read
Browse files

Fix Technical Writing pages in handbook

parent 6de0742e
Loading
Loading
Loading
Loading
+4 −5
Original line number Diff line number Diff line
---
title: "Technical Writing"
description: "The Technical Writing team continuously develops the GitLab product documentation to meet users' and administrators' needs."
---

The GitLab Technical Writing team collaborates with developers, product managers, and the community to develop product documentation.
@@ -117,7 +116,8 @@ Some content on docs.gitlab.com is [not reviewed by TWs](#content-not-reviewed-b

### Assignments to DevOps Stages and Groups

{{% alert title="**If you were directed here from a documentation page's metadata:**" color="primary" %}}
{{% alert title="Note" color="primary" %}}
**If you were directed here from a documentation page's metadata:**
References to stages and groups in documentation metadata don't indicate developer group ownership, but instead help connect people to the assigned stable counterpart technical writer with subject matter awareness.
If internal groups want to use other metadata parameters to track information in documentation pages, please create an issue in the Technical Writing repository for discussion.
Additional discussions are in [this issue](https://gitlab.com/gitlab-org/technical-writing/-/issues/547).
@@ -132,13 +132,12 @@ all situations where documentation is required.

When a Technical Writer [is on PTO](#technical-writer-pto), the whole team acts as their backup.

**Note:** If you've been directed here from metadata in a documentation page
If you've been directed here from metadata in a documentation page
that has `none` as the stage, refer to the
[Assignments to other projects and subjects](#assignments-to-other-projects-and-subjects)
section, referencing the group shown in metadata with the listed Subjects in the table.


{{% alert color="primary" %}}
{{% alert title="Note" color="primary" %}}
Not sure who's responsible for a feature? Review feature assignments by [stage](https://about.gitlab.com/features/) or [group](/handbook/product/categories/features/).
{{% /alert %}}

+0 −1
Original line number Diff line number Diff line
---
title: "Technical Writing Fundamentals"
description: "Get started working on GitLab product documentation with our Technical Writing Fundamentals."
---

The Technical Writing Fundamentals course is available to help both GitLab and community contributors write and edit documentation for the product. This course provides direction on grammar and topic design.
+0 −2
Original line number Diff line number Diff line
---
aliases: /handbook/product/ux/technical-writing/fundamentals/examples.html
title: "Editing content into different topic types"
description: "View examples of how to transform content into concept, task, reference, and troubleshooting topics."
---

We often write pages of documentation that contain disparate kinds of information.
+0 −1
Original line number Diff line number Diff line
---
title: "Hiring Technical Writers"
description: "The internal process for hiring Technical Writers at GitLab."
---

As GitLab grows, the Technical Writing team expands, and team members participate in interviews. A defined interview
+1 −2
Original line number Diff line number Diff line
---
title: "Setting Up a Local Environment"
description: "Tips and suggestions for setting up a local environment to write and preview GitLab product documentation."
title: "Setting up a local environment"
---

Whether you are a contributor or a GitLab Technical Writing team member, one of your first tasks is to set up
Loading