Skip to content
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

docs: migrate node ID in bridge-node, full-storage-node, light-node #1685

Merged
merged 5 commits into from
Aug 28, 2024

Conversation

doodleoo3
Copy link
Contributor

@doodleoo3 doodleoo3 commented Aug 25, 2024

Overview

Currently, the node id migration process is not very transparent in the documentation. This PR fixes that

Summary by CodeRabbit

  • New Features
    • Added detailed migration instructions for bridge, full storage, and light nodes in the documentation, enhancing usability and functionality for users transferring node IDs to new servers.

Copy link
Contributor

coderabbitai bot commented Aug 25, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new sections in the documentation for the Celestia bridge, full storage, and light nodes. Each section outlines a two-step process for migrating a node ID to a new server, which includes backing up specific files and uploading them to the new server before starting the node. This addition provides users with clear instructions for node ID migration.

Changes

Files Change Summary
nodes/bridge-node.md Added a new section detailing the migration process for a bridge node ID.
nodes/full-storage-node.md Added a new section detailing the migration process for a full storage node ID.
nodes/light-node.md Added a new section detailing the migration process for a light node ID.

Poem

🐰 In the digital fields where the nodes do play,
A hop for the bridge, a leap for the way.
With files to backup and new homes in sight,
Our node IDs dance in the soft moonlight.
Migration is smooth, like a breeze in the night,
Let's celebrate change, with hearts full of delight! 🌙✨


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a8f6631 and 7e1acb3.

Files selected for processing (3)
  • nodes/bridge-node.md (1 hunks)
  • nodes/full-storage-node.md (1 hunks)
  • nodes/light-node.md (1 hunks)
Additional context used
LanguageTool
nodes/full-storage-node.md

[grammar] ~155-~155: The word “backup” is a noun. The verb is spelled with a space.
Context: ...a full storage node ID: 1. You need to backup two files located in the celestia-full ...

(NOUN_VERB_CONFUSION)

nodes/light-node.md

[grammar] ~198-~198: The word “backup” is a noun. The verb is spelled with a space.
Context: ...igrate a light node ID: 1. You need to backup two files located in the celestia-light...

(NOUN_VERB_CONFUSION)

nodes/bridge-node.md

[grammar] ~196-~196: The word “backup” is a noun. The verb is spelled with a space.
Context: ...grate a bridge node ID: 1. You need to backup two files located in the celestia-bridg...

(NOUN_VERB_CONFUSION)

Additional comments not posted (3)
nodes/full-storage-node.md (1)

151-157: Approve new section on node ID migration.

The new section provides clear, step-by-step instructions for migrating a node ID, which enhances the documentation and supports the PR's objectives.

Tools
LanguageTool

[grammar] ~155-~155: The word “backup” is a noun. The verb is spelled with a space.
Context: ...a full storage node ID: 1. You need to backup two files located in the celestia-full ...

(NOUN_VERB_CONFUSION)

nodes/light-node.md (1)

194-200: Approve new section on light node ID migration.

The new section provides clear, step-by-step instructions for migrating a light node ID, which enhances the documentation and supports the PR's objectives.

Tools
LanguageTool

[grammar] ~198-~198: The word “backup” is a noun. The verb is spelled with a space.
Context: ...igrate a light node ID: 1. You need to backup two files located in the celestia-light...

(NOUN_VERB_CONFUSION)

nodes/bridge-node.md (1)

192-198: Approve new section on bridge node ID migration.

The new section provides clear, step-by-step instructions for migrating a bridge node ID, which enhances the documentation and supports the PR's objectives.

Tools
LanguageTool

[grammar] ~196-~196: The word “backup” is a noun. The verb is spelled with a space.
Context: ...grate a bridge node ID: 1. You need to backup two files located in the celestia-bridg...

(NOUN_VERB_CONFUSION)

nodes/full-storage-node.md Outdated Show resolved Hide resolved
nodes/light-node.md Outdated Show resolved Hide resolved
nodes/bridge-node.md Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
nodes/bridge-node.md Outdated Show resolved Hide resolved
nodes/full-storage-node.md Outdated Show resolved Hide resolved
nodes/light-node.md Outdated Show resolved Hide resolved
Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you @doodleoo3 !

@jcstein jcstein merged commit c76c449 into celestiaorg:main Aug 28, 2024
1 of 2 checks passed
This was referenced Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants