Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .github/ISSUE_TEMPLATE/docs_audit_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,35 @@ labels: 'docs-audit-2024-Q4,op-labs'
> Choose the appropriate github issue labels for each page.

<details>

<summary>Priority</summary>

- `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.
- `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.
- `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.
- `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.
- `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.

</details>

<details>

<summary>T-shirt size</summary>

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

<details>

<summary>Content evaluation</summary>
- `a-delete`: don't need this page
- `a-duplicate`: some content lives elsewhere
- `a-minor`: needs small revisions
- `a-moderate`: needs moderate revisions
- `a-critical`: needs a lot of work
</details>

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

<details>
<summary>Component tags</summary>

```
op-node
op-geth
Expand Down Expand Up @@ -104,11 +115,13 @@ zdd-service
snapman
security-tools
superchain-ops
op-deployer
```
</details>

<details>
<summary>Engineering tags</summary>

```
eng-platforms
eng-growth
Expand Down