Skip to content
Snippets Groups Projects
Commit f0534ea3 authored by Cynthia "Arty" Ng's avatar Cynthia "Arty" Ng :speech_balloon: Committed by Ian Pedowitz
Browse files

Remove handbook bug label and consolidate folders

parent d0bd2830
No related branches found
No related tags found
1 merge request!5993Remove handbook bug label and consolidate folders
......@@ -29,7 +29,6 @@
/content/ @sytses @streas @gitlab-com/egroup
/content/handbook/about/handbook-usage.md @sytses @streas @gitlab-com/content-sites
/content/handbook/about/ @gitlab-com/content-sites
/content/handbook/content-websites/ @gitlab-com/content-sites
/content/handbook/editing-handbook/ @gitlab-com/content-sites
[Job Families]
......
......@@ -37,4 +37,4 @@ Please do *no* use this for content issues, such as typos.
<!-- If you can, link to the line of code that might be responsible for the problem. -->
<!-- Please read the priority and severity guidelines before updating the labels: https://handbook.gitlab.com/handbook/content-websites/#severity -->
/label ~"Handbook::Bug" ~"hb-priority::4" ~"hb-severity::4"
/label ~"Handbook::Content" ~"type::bug" ~"hb-priority::4" ~"hb-severity::4"
---
title: "Direction"
aliases: /handbook/content-websites/direction/
---
## Overview
......
---
title: "Content Websites"
aliases: /handbook/content-websites/
---
## Overview
......@@ -60,9 +61,10 @@ Handbook issues typically fall under one of the following:
1. Content: Anything related to updating the text in the handbook, including required fixes.
1. Feature: New or an enhancement of how the handbook works, such as theme, or shortcode.
1. Operations: Theme, pipeline, local development, linters, other maintenance, and related documentation.
1. Bug: Problem that prevents users from contributing, typically related to handbook operations.
The team overseeing the content websites generally only resources operations and bug issues,
Issues may be considered a bug separately from the category when applicable (not a feature).
The team overseeing the content websites generally only resources operations issues,
unless the issue is a blocker for contributing or using the handbook.
### Priority
......@@ -85,17 +87,14 @@ We encourage contributions for all issues, especially priority 3 and 4 issues, t
### Severity
Severity labels help us determine urgency and clearly communicate the impact of a ~"Handbook::bug" on users.
Content issues, such as typos, are *not* bug issues.
Severity may be applied, but
Severity labels help us determine urgency and clearly communicate the impact of a ~"Handbook::Operations" issue on users.
The severity should be determined based the various factors in the table below.
When an issue falls under multiple categories, use your best judgment.
Once you've determined a severity for an issue add a note that explains in summary why you selected the severity you did. This will help future team members understand your rationale so they will know how to proceed with acting upon the issue.
| Type of `~"Handbook::bug"` | `~"hb-severity::1"`: Blocker | `~"hb-severity::2"`: High | `~"hb-severity::3"`: Medium | `~"hb-severity::4"`: Low |
| `~"Handbook::Operations" ~"type::bug"` | `~"hb-severity::1"`: Blocker | `~"hb-severity::2"`: High | `~"hb-severity::3"`: Medium | `~"hb-severity::4"`: Low |
|----------------|--------------------------|---------------------------|-------------------------|----------------------|
| General bugs | Broken feature with no workaround or any data-loss. | Broken feature with an unacceptably complex workaround. | Broken feature with a workaround. | Functionality is inconvenient. |
| Impact on users | Impacts 20% or more of users without an available workaround | Impacts 20% or more of users, but a reasonable workaround is available<br/><br/>**AND/OR**<br/><br/>Impacts between 5%-20% of users without an available workaround | Impacts up to 20% of users with a reasonable workaround, or workaround not required. | Minimal impact on typical user's workflow. Workaround is available or not needed. |
......
......@@ -73,7 +73,7 @@ Examples of an under-resourced project:
There may be projects with no clear leader for a myriad of reasons, including that we're still hiring the point person or the lead is on leave.
Because of the team's ability to come up to speed quickly, they may be tasked with something totally out of their domain with the expectation that they bring their leadership experience to the table, will do the work to make good decisions, and will lean on team members who are subject-matter experts.
For example, there has historically been no DRI for the [handbook or related content sites]({{< ref content-websites >}}). As it became clear that this was a GitLab priority, but no function planned to prioritize this within the coming year, the Office of the CEO stepped in to take on handbook ownership.
For example, there has historically been no DRI for the [handbook or related content sites](/handbook/about/maintenance/). As it became clear that this was a GitLab priority, but no function planned to prioritize this within the coming year, the Office of the CEO stepped in to take on handbook ownership until an owner could be identified.
Examples of projects with no clear leader:
......
......@@ -290,7 +290,7 @@ is "broken" and pipelines are failing for everyone, the root issue is most likel
1. There are two ways to fix. Either:
1. Make the code itself more robust to deal with the types of values it may encounter.
However, not everyone knows Go and Hugo well enough to do that quickly.
If needed, create a "handbook::bug" issue in the handbook repository to document the problem
If needed, create a "Handbook::Operations" "type::bug" issue in the handbook repository to document the problem
after fixing the pipeline issue.
1. Edit the data file to have values the build won't fail on.
......
......@@ -79,15 +79,13 @@
- name: Handbook Usage
url: handbook-usage
- name: Contribution Guide
url: docs
- name: Practical Handbook Edits
url: /handbook/editing-handbook/practical-handbook-edits
- name: Edit This Website Locally
url: /docs/development
url: /docs/development/
- name: Editing the handbook
url: /handbook/editing-handbook/
- name: Handbook Style Guide
url: /handbook/about/style-guide
- name: Content Websites
url: content-websites
url: /handbook/about/style-guide/
- name: Handbook maintenance
url: /handbook/about/maintenance/
- name: People Group
icon: fa-solid fa-people-group
url: /handbook/people-group/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment