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

docs: add config files documentation #585

Merged
merged 1 commit into from
Nov 12, 2023

Conversation

rach-id
Copy link
Member

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

Overview

Closes #584

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 deployment command for Blobstream contract, simplifying parameters and clarifying usage.
    • Revised CLI command for starting the orchestrator, emphasizing flag precedence and config file location.
    • Modified relayer start command, emphasizing use of TOML config file and clarifying passphrase prompt.

@rach-id rach-id added the documentation Improvements or additions to documentation label Nov 10, 2023
@rach-id rach-id self-assigned this Nov 10, 2023
@rach-id rach-id requested a review from evan-forbes as a code owner November 10, 2023 13:49
Copy link
Contributor

coderabbitai bot commented Nov 10, 2023

Walkthrough

The changes introduced in the diff primarily focus on streamlining the deployment and configuration process for the Blobstream contract and its associated orchestrator and relayer. The modifications include updates to the CLI commands and parameters, emphasis on the use of TOML config files, and clarifications on prompts and behaviors.

Changes

File Change Summary
docs/deploy.md Updated deployment command for Blobstream contract, modified parameters, and clarified behavior of custom nonce option.
docs/orchestrator.md Emphasized precedence of CLI flags over config files, added note about TOML config file location and EVM key passphrase prompt, and updated systemd service configuration example.
docs/relayer.md Streamlined relayer start command, emphasized use of TOML config file, and clarified EVM key passphrase prompt.

Assessment against linked issues (Beta)

Objective Addressed Explanation
Document config files (584) The changes provide some information about the use of config files, but it's unclear if they fully document the purpose, structure, and usage of the configuration files in the celestiaorg/orchestrator-relayer project.

Poem

🐇 Hopping through the code, making changes bold, 🍂

In the season of fall, we've made Blobstream's deployment unfold! 🎉


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 help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

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 rach-id requested a review from jcstein November 10, 2023 13:50
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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4f6aa67 and b5f8fe6.
Files selected for processing (3)
  • docs/deploy.md (1 hunks)
  • docs/orchestrator.md (2 hunks)
  • docs/relayer.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • docs/deploy.md
  • docs/relayer.md

docs/orchestrator.md Show resolved Hide resolved
docs/orchestrator.md Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

Merging #585 (b5f8fe6) into main (29598b1) will decrease coverage by 0.01%.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #585      +/-   ##
==========================================
- Coverage   26.64%   26.63%   -0.01%     
==========================================
  Files          29       29              
  Lines        2961     2962       +1     
==========================================
  Hits          789      789              
- Misses       2077     2078       +1     
  Partials       95       95              

see 1 file with indirect coverage changes

@rach-id rach-id merged commit 5bbffbc into celestiaorg:main Nov 12, 2023
18 checks passed
jcstein added a commit to celestiaorg/docs that referenced this pull request Nov 12, 2023
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.

:shipit:

jcstein added a commit to celestiaorg/docs that referenced this pull request Nov 16, 2023
* chore: update blobstream docs

based on celestiaorg/orchestrator-relayer#585

* chore: update bstream docs
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document config files
4 participants