Determine if Support is primary contributor for certain doc pages and clarify ownership/roles
While Support is encouraged to add to any and all pages of the docs, there are some where Support is the primary author.
Here's the list of pages that would benefit from Support's review:
Page | Primary Stage/Group |
---|---|
Debugging Tips | deprecate? see #228961 (comment 382744013) |
Diagnostics tools | List of tools. No applicable group. Notes: Missing JSON stats. Overlaps with blog post. |
Troubleshooting Elasticsearch | groupglobal search |
GitLab Rails Console Cheat Sheet | deprecate? see #228961 (comment 382744013) |
Group SAML and SCIM troubleshooting | ~"group::access" |
Kubernetes, GitLab and You | deprecate? see #228961 (comment 383041052) |
Linux Cheat Sheet | No applicable group |
Parsing GitLab logs with jq |
deprecate? see #228961 (comment 382744013) |
Navigating GitLab via Rails console | No applicable group. |
PostgreSQL | groupdatabase but see #228961 (comment 382236773) for more info |
Troubleshooting Sidekiq | No applicable group per #228961 (comment 383871872) |
Troubleshooting SSL | groupdistribution see #228961 (comment 382687003) |
Apps for a Testing Environment | Deprecate in favour of others docs? GDK and Support testing environment |
Please look over the list and help us decide which stage/group has the majority of the information on each page, so that we can have a Technical Writer that is generally responsible for the content. (Note that the associated stage/group may not cover everything on the page -- we primarily want people to have some way to connect with a single TW to help them, if needed.) Although we'd prefer to get each page linked to a stage/group, if you literally can't make an association, enter "n/a" and we'll find some other method to determine the associated Technical Writer for that page.
Previous description:
If there are Support-specific pages in the docs that aren't in the previous list, please call them out or add them to the list, and we'll determine some method to indicate them, to help people connect with the Technical Writer that's primarily tasked with those Support-aligned pages.
Let's aggregate these to decide if each should be owned by:
- a stage group, with the assigned technical writer as maintainer.
- Support itself, with a member of Support as maintainer.
- Support itself, with Staff TW @mikelewis as maintainer.
- None of the above, with Staff TW @mikelewis as maintainer.
Pages to consider:
- https://docs.gitlab.com/ee/subscriptions/
- https://docs.gitlab.com/ee/administration/troubleshooting/
Background:
TW leadership is looking to clarify potential jobs on the TW team for engaging with Support. It would be helpful to know if certain types of MRs would go directly to such DRI(s) by virtue of their stage/group ownership frontmatter (or labeling 'Support' there, instead, if more applicable).