Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

docs: document the importance of running orchestrator #626

Merged
merged 3 commits into from
Nov 28, 2023

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Nov 28, 2023

Overview

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions for Blobstream with the correct version number.
    • Added important notes for validators on the necessity of running a Blobstream orchestrator in both mocha and mainnet environments.
    • Highlighted the consequences of not running an orchestrator, including social slashing and protocol enforcement.

@rach-id rach-id added documentation Improvements or additions to documentation orchestrator orchestrator related labels Nov 28, 2023
@rach-id rach-id requested a review from jcstein November 28, 2023 09:47
@rach-id rach-id self-assigned this Nov 28, 2023
@rach-id rach-id requested a review from evan-forbes as a code owner November 28, 2023 09:47
Copy link
Contributor

coderabbitai bot commented Nov 28, 2023

Walkthrough

The recent updates include a minor correction in the README.md file, adjusting the version number for Go installation. More importantly, there are repeated notes added to the orchestrator documentation, stressing the critical role of the Blobstream orchestrator for validators on mocha and mainnet. Validators are reminded of the necessity to run an orchestrator, with warnings of potential consequences, such as social slashing and protocol enforcement, for non-compliance.

Changes

File Change Summary
README.md Corrected Go version number in installation instructions.
docs/orchestrator.md Added notes on the mandatory nature of running a Blobstream orchestrator for validators, with emphasis on the consequences of non-compliance.

🐇✨
To the rhythm of the code, we hop and leap,
With every commit, the network we keep.
Orchestrators must run, validators take heed,
For a healthy chain, this is what we need. 🌐🔒


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

@rach-id
Copy link
Member Author

rach-id commented Nov 28, 2023

@jcstein Does it also make sense to add a note in the validator tutorial stating that blobstream orchestrator is mandatory for mocha and mainnet?

@codecov-commenter
Copy link

codecov-commenter commented Nov 28, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c229e91) 26.09% compared to head (b63db2b) 26.09%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #626   +/-   ##
=======================================
  Coverage   26.09%   26.09%           
=======================================
  Files          29       29           
  Lines        3023     3023           
=======================================
  Hits          789      789           
  Misses       2139     2139           
  Partials       95       95           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/orchestrator.md Outdated Show resolved Hide resolved
Co-authored-by: Evan Forbes <[email protected]>
@rach-id rach-id requested a review from evan-forbes November 28, 2023 16:02
@evan-forbes
Copy link
Member

can we also update the name of the PR?

@rach-id rach-id changed the title docs: document that running orchestrator is mandatory docs: document the importance of running orchestrator Nov 28, 2023
@rach-id rach-id enabled auto-merge (squash) November 28, 2023 20:28
@rach-id rach-id merged commit d6df3b4 into celestiaorg:main Nov 28, 2023
17 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation orchestrator orchestrator related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants