-
Notifications
You must be signed in to change notification settings - Fork 267
adding audit template #891
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
--- | ||
name: Docs audit results | ||
about: Template for a formal technical documentation audits run by OP Labs | ||
title: "[2024 Q4 Audit] [page-path]" | ||
labels: 'docs-audit-2024-Q4,op-labs' | ||
--- | ||
|
||
<!-- this template is intended for internal OP Labs usage --> | ||
|
||
## Description of the updates required | ||
|
||
> Write a description of the current state of the page. | ||
sbvegan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Github issue label criteria | ||
|
||
> 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> | ||
sbvegan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `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. | ||
sbvegan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
</details> | ||
|
||
## MDX Metadata format | ||
sbvegan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
> We will be adding better metadata to the header of each page. | ||
> If I was actively searching for this page on google and this description was the search result, would I know it's the correct page? | ||
> Parse the component and feature tags to add. | ||
|
||
--- | ||
title: "Your Title Here" | ||
tags: ["tag1", "tag2"] | ||
description: "A short description of the content." | ||
--- | ||
|
||
<details> | ||
<summary>Component tags</summary> | ||
``` | ||
op-node | ||
op-geth | ||
op-reth | ||
op-erigon | ||
op-nethermind | ||
batcher | ||
standard-bridge | ||
sequencer | ||
l1-contracts | ||
l2-contracts | ||
precompiles | ||
predeploys | ||
preinstalls | ||
op-proposer | ||
op-challenger | ||
op-gov-token | ||
op-supervisor | ||
op-conductor | ||
fp-contracts | ||
cannon | ||
op-program | ||
asterisc | ||
kona | ||
superchain-registry | ||
supersim | ||
dev-console | ||
opsm | ||
mcp | ||
mcp-l2 | ||
deputy-guardian | ||
liveness-guard | ||
dispute-mon | ||
op-beat | ||
op-signer | ||
monitorism | ||
blockspace-charters | ||
op-workbench | ||
kubernetes-infrastructure | ||
devops-tooling | ||
artifacts-packaging | ||
sequencer-in-a-box | ||
devnets | ||
op-supervisor | ||
performance-tooling | ||
peer-management-service | ||
proxyd | ||
zdd-service | ||
snapman | ||
security-tools | ||
superchain-ops | ||
``` | ||
</details> | ||
|
||
<details> | ||
<summary>Engineering tags</summary> | ||
``` | ||
eng-platforms | ||
eng-growth | ||
eng-devx | ||
eng-protocol | ||
eng-proofs | ||
eng-evm | ||
eng-security | ||
``` | ||
</details> | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.