Add links to OP Mainnet runbook #997
Conversation
alfonso-op
added
the
tutorial
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request involves substantial updates to two documentation files focused on node operations and self-hosted chains. The document "How to Run a Node in the Superchain" has been revised to include detailed explanations of OP Stack rollup node architecture, configuration options, and monitoring setup. It also clarifies the prerequisites for running the node. Meanwhile, "How to Start a Self-Hosted Chain" has been enhanced with a new section directing users to OP Mainnet Runbooks for operational insights. These changes aim to improve clarity and usability of the guides. Changes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
pages/builders/node-operators/rollup-node.mdx (1)
124-125: Approve addition of OP Mainnet Runbooks link with minor suggestions.The addition of the link to OP Mainnet Runbooks aligns well with the PR objectives and provides valuable resources for node operators. Consider the following suggestions:
- Improve clarity by replacing "deeper insight" with a more specific phrase:
-For deeper insight into the day-to-day operations of OP Mainnet to see how these practices could apply to your own node operations, see the public [OP Mainnet Runbooks](https://www.notion.so/oplabs/Optimism-Runbooks-WIP-120f153ee1628045b230d5cd3df79f63?pvs=4). +For detailed guidance on the day-to-day operations of OP Mainnet and how to apply these practices to your own node operations, refer to the public [OP Mainnet Runbooks](https://www.notion.so/oplabs/Optimism-Runbooks-WIP-120f153ee1628045b230d5cd3df79f63?pvs=4).
- Remember to update the link once the corresponding page is published, as mentioned in the PR objectives.
🧰 Tools
🪛 LanguageTool
[style] ~124-~124: Consider an alternative adjective to strengthen your wording.
Context: ...source code. | 🟡 Medium | For deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
pages/builders/chain-operators/self-hosted.mdx (1)
108-109: Consider rephrasing and using a more stable link format.The new paragraph adds valuable context by referencing the OP Mainnet Runbooks. However, consider the following suggestions:
- Rephrase "deeper insight" to "more comprehensive insight" for stronger wording.
- Consider using a more stable link format instead of a direct Notion URL. This could be a redirect from the official documentation domain or a GitHub repository link, which would be more maintainable in the long term.
Here's a suggested revision:
Lastly, for more comprehensive insight into the day-to-day operations of OP Mainnet and how these operational practices could apply to your chain, see the public [OP Mainnet Runbooks](https://docs.optimism.io/operators/runbooks).Note: Replace the example URL with the actual stable link to the runbooks.
🧰 Tools
🪛 LanguageTool
[style] ~108-~108: Consider an alternative adjective to strengthen your wording.
Context: ...'d love to grow this list! Lastly, for deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- pages/builders/chain-operators/self-hosted.mdx (1 hunks)
- pages/builders/node-operators/rollup-node.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/chain-operators/self-hosted.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"pages/builders/node-operators/rollup-node.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/builders/chain-operators/self-hosted.mdx
[style] ~108-~108: Consider an alternative adjective to strengthen your wording.
Context: ...'d love to grow this list! Lastly, for deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
pages/builders/node-operators/rollup-node.mdx
[style] ~124-~124: Consider an alternative adjective to strengthen your wording.
Context: ...source code. | 🟡 Medium | For deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
🔇 Additional comments (1)
pages/builders/chain-operators/self-hosted.mdx (1)
Line range hint
111-114: LGTM: New "Next Steps" section is informative and well-structured.The new "Next Steps" section provides valuable guidance for users who have completed the main tutorial. It effectively directs readers to additional resources for common operations and troubleshooting. The content is clear, concise, and adheres to the provided coding guidelines.
🧰 Tools
🪛 LanguageTool
[style] ~108-~108: Consider an alternative adjective to strengthen your wording.
Context: ...'d love to grow this list! Lastly, for deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
|
@sbvegan I see that you assigned yourself to this, but just wanted to jump in and say this seems like a problematic pattern to follow in the long term. I'd vote we look into migrating these into the monorepo at a minimum or the docs site if possible. Seems fine to me in the short term, but I think this could easily cause maintenance issues over time. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
pages/builders/chain-operators/self-hosted.mdx (1)
108-109: Valuable addition, but consider placement and wording.The addition of the OP Mainnet Runbooks link is a valuable resource for chain operators. However, consider the following suggestions:
Move this content to a more appropriate section, such as after the "Launch Your Chain on Mainnet" section or create a new "Additional Resources" section. It doesn't directly relate to tutorials.
Remember to update the link once the corresponding page is published, as mentioned in the PR objectives.
Consider rephrasing the sentence to strengthen its impact:
- Lastly, for deeper insight into the day-to-day operations of OP Mainnet to see how these operational practices could apply to your chain, see the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63). + For comprehensive insight into the day-to-day operations of OP Mainnet and to understand how these operational practices could apply to your chain, refer to the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63).🧰 Tools
🪛 LanguageTool
[style] ~108-~108: Consider an alternative adjective to strengthen your wording.
Context: ...'d love to grow this list! Lastly, for deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
- pages/builders/chain-operators/self-hosted.mdx (1 hunks)
- pages/builders/node-operators/rollup-node.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/builders/chain-operators/self-hosted.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"pages/builders/node-operators/rollup-node.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🪛 LanguageTool
pages/builders/chain-operators/self-hosted.mdx
[style] ~108-~108: Consider an alternative adjective to strengthen your wording.
Context: ...'d love to grow this list! Lastly, for deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
pages/builders/node-operators/rollup-node.mdx
[style] ~124-~124: Consider an alternative adjective to strengthen your wording.
Context: ...source code. | 🟡 Medium | For deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
🔇 Additional comments (2)
pages/builders/node-operators/rollup-node.mdx (2)
Line range hint
1-123: Well-structured and comprehensive guide.The document provides a thorough and well-organized guide for running a node in the Superchain. The use of MDX components, clear section headers, and logical flow enhances readability and user experience. The content covers all essential aspects of node operation, making it a valuable resource for node operators.
🧰 Tools
🪛 LanguageTool
[style] ~124-~124: Consider an alternative adjective to strengthen your wording.
Context: ...source code. | 🟡 Medium | For deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
124-125: Valuable addition of OP Mainnet Runbooks reference.The new paragraph provides a helpful link to the public OP Mainnet Runbooks, offering additional resources for node operators. This addition enhances the overall value of the guide.
Consider the following suggestions:
- For more impactful wording, consider replacing "deeper insight" with "comprehensive understanding" or "in-depth knowledge".
- The use of a Notion URL for the runbooks might pose maintenance challenges in the future. Consider migrating this content to a more stable platform or the documentation site itself for better long-term sustainability.
To verify the Notion URL and its potential impact, run the following script:
🧰 Tools
🪛 LanguageTool
[style] ~124-~124: Consider an alternative adjective to strengthen your wording.
Context: ...source code. | 🟡 Medium | For deeper insight into the day-to-day operations ...(DEEP_PROFOUND)
Adds links in the Node and Chain Operator tutorial indeces to our public OP Mainnet runbooks.
The links currently point to an internal Notion page and will need to be updated once the page is published.