Skip to content

Commit ed9d5ae

Browse files
authored
Merge pull request #916 from ethereum-optimism/audit
adding the content eval back
2 parents 946f883 + 85c8ef8 commit ed9d5ae

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

.github/ISSUE_TEMPLATE/docs_audit_results.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,35 @@ labels: 'docs-audit-2024-Q4,op-labs'
1616
> Choose the appropriate github issue labels for each page.
1717
1818
<details>
19+
1920
<summary>Priority</summary>
2021

2122
- `p-on-hold`: (Defer) Tasks that are currently not actionable due to various reasons like waiting for external inputs, dependencies, or resource constraints. These are reviewed periodically to decide if they can be moved to a more active status.
2223
- `p-low`: (Nice to do) Tasks that have minimal impact on core operations and no immediate deadlines. These tasks are often more about quality of life improvements rather than essential needs.
2324
- `p-medium`: (Could do) Tasks that need to be done but are less critical than high-priority tasks. These often improve processes or efficiency but can be postponed if necessary without immediate severe repercussions.
2425
- `p-high`: (Should do) Important tasks that contribute significantly to long-term goals but may not have an immediate deadline. Delaying these tasks could have considerable negative effects but are not as immediate as critical tasks.
2526
- `p-critical`: Tasks that have immediate deadlines or significant consequences if not completed on time. These are non-negotiable and often linked to core business functions or legal requirements.
26-
2727
</details>
2828

2929
<details>
30+
3031
<summary>T-shirt size</summary>
3132

3233
- `s-XS`: (< 1 day) Very simple tasks that require minimal time and effort.
3334
- `s-S`: (few days) Tasks that are straightforward but require a bit more time to complete.
3435
- `s-M`: (1-2 weeks) Tasks that involve a moderate level of complexity and collaboration.
3536
- `s-L`: (several weeks) Complex tasks that require significant time investment and coordination across multiple teams.
3637
- `s-XL`: (> 1 month) Very large and complex projects that involve extensive planning, execution, and testing.
38+
</details>
3739

40+
<details>
41+
42+
<summary>Content evaluation</summary>
43+
- `a-delete`: don't need this page
44+
- `a-duplicate`: some content lives elsewhere
45+
- `a-minor`: needs small revisions
46+
- `a-moderate`: needs moderate revisions
47+
- `a-critical`: needs a lot of work
3848
</details>
3949

4050
## MDX Metadata format
@@ -53,6 +63,7 @@ description: "A short description of the content."
5363

5464
<details>
5565
<summary>Component tags</summary>
66+
5667
```
5768
op-node
5869
op-geth
@@ -104,11 +115,13 @@ zdd-service
104115
snapman
105116
security-tools
106117
superchain-ops
118+
op-deployer
107119
```
108120
</details>
109121

110122
<details>
111123
<summary>Engineering tags</summary>
124+
112125
```
113126
eng-platforms
114127
eng-growth

0 commit comments

Comments
 (0)