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: update validator docs #2507

Merged
merged 1 commit into from
Apr 24, 2024
Merged

docs: update validator docs #2507

merged 1 commit into from
Apr 24, 2024

Conversation

robert-zaremba
Copy link
Member

@robert-zaremba robert-zaremba commented Apr 24, 2024

Description

Validator notes updates based on onboarding few new validators.

Summary by CodeRabbit

  • Documentation
    • Updated the validator node guide with new instructions on endpoint accessibility and staying informed via Discord.

Copy link
Contributor

coderabbitai bot commented Apr 24, 2024

Walkthrough

The update enhances the guidance for running a validator node, focusing on the necessity of monitoring blocked endpoints based on geographical location. It also encourages staying actively connected through Discord for the latest updates and information.

Changes

File Summary
docs/VALIDATOR.md Added instructions for checking blocked endpoints and staying updated via Discord.

🐇✨
In the land of code and node,
A rabbit hopped down the road.
"Check your paths," it squeaked with glee,
"Stay connected, and you'll see,
How smoothly all your blocks will be!" 🌟
🐇💻


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 97af6be and f5de247.
Files selected for processing (1)
  • docs/VALIDATOR.md (1 hunks)
Additional Context Used
LanguageTool (48)
docs/VALIDATOR.md (48)

Near line 3: Possible spelling mistake found.
Context: ...cument describes a process of joining a testnet or a mainnet as a validator. ## Umeeve...


Near line 3: Possible spelling mistake found.
Context: ...bes a process of joining a testnet or a mainnet as a validator. ## Umeeversity Full d...


Near line 11: Possible spelling mistake found.
Context: ...You need 2 binaries to run a validator: umeed and price-feeder. Make sure you run...


Near line 13: Possible spelling mistake found.
Context: ...e sure you run the right binary for the testnet or the mainnet. Consult the chain upgra...


Near line 13: Possible spelling mistake found.
Context: ...the right binary for the testnet or the mainnet. Consult the chain upgrades on [mainnet...


Near line 13: Possible spelling mistake found.
Context: ...mainnet. Consult the chain upgrades on [mainnet](https://www.mintscan.io/umee/proposals...


Near line 13: Possible spelling mistake found.
Context: ...://www.mintscan.io/umee/proposals) and [testnet](https://explorer.network.umee.cc/Canon...


Near line 15: Possible spelling mistake found.
Context: ...orer.network.umee.cc/Canon-4/gov). ### Umeed You can get a binary by: 1. [Build](....


Near line 19: Unpaired symbol: ‘[’ seems to be missing
Context: ...eed You can get a binary by: 1. Build yourself and follow...


Near line 21: Possible spelling mistake found.
Context: ...our validator OS, then you need to copy libwasmvm: ```sh scp $GOPATH/pkg/mod/gith...


Near line 27: Possible spelling mistake found.
Context: .../path> ``` NOTE: use the correct wasmvm version, according to the latest [Rele...


Near line 29: Possible spelling mistake found.
Context: ...untu LTS x86-64. You MUST also copy the libwasmvm (See note in 2. about libwasmvm versio...


Near line 29: This sentence does not start with an uppercase letter.
Context: ...so copy the libwasmvm (See note in 2. about libwasmvm version): ```sh wget h...


Near line 29: Possible spelling mistake found.
Context: ...y the libwasmvm (See note in 2. about libwasmvm version): ```sh wget https://raw...


Near line 35: Possible spelling mistake found.
Context: ....so ``` 4. Use our released docker [umeed container](https://github.com/umee-netw...


Near line 37: Possible spelling mistake found.
Context: .../pkgs/container/umeed). To test if the libwasm is linked correctly, run `umeed versio...


Near line 37: Possible spelling mistake found.
Context: ... the libwasm is linked correctly, run umeed version. ### Price Feeder We are usi...


Near line 41: Possible spelling mistake found.
Context: ...rsion`. ### Price Feeder We are using Ojo Price Feeder. Please follow the [instru...


Near line 41: Possible spelling mistake found.
Context: ...ure you use the latest release with the umee/ prefix (eg: umee/v2.4.0). NOTE: for...


Near line 41: Possible spelling mistake found.
Context: ...latest release with the umee/ prefix (eg: umee/v2.4.0). NOTE: for self buildin...


Near line 41: Possible spelling mistake found.
Context: ...st release with the umee/ prefix (eg: umee/v2.4.0). NOTE: for self building and c...


Near line 42: Possible spelling mistake found.
Context: ...nfiguration examples, you MUST use the [umee branch](https://github.com/ojo-network/...


Near line 45: Possible missing comma found.
Context: ...eeder.example.toml). - For the provider config you can use our latest [umee-provider-c...


Near line 45: Possible spelling mistake found.
Context: ...provider config you can use our latest [umee-provider-config directory](https://github.com/ojo-netwo...


Near line 46: The verb ‘depend’ requires the preposition ‘on’ (or ‘upon’).
Context: ...e/umee/umee-provider-config) as is. - Depending where you run your validator node, cert...


Near line 47: Possible spelling mistake found.
Context: ...3581490196/1161391685595561984) for the testnet and [validator-announcements](https://d...


Near line 47: Possible spelling mistake found.
Context: ...13581490196/940268469285449809) for the mainnet. ## Running a node 1. Update the `app...


Near line 51: Possible spelling mistake found.
Context: ...nnet. ## Running a node 1. Update the app.toml, client.toml and config.toml based...


Near line 51: Possible spelling mistake found.
Context: ...nning a node 1. Update the app.toml, client.toml and config.toml based on your prefer...


Near line 51: Possible spelling mistake found.
Context: ...pdate the app.toml, client.toml and config.toml based on your preference. You MUST set...


Near line 51: Possible spelling mistake found.
Context: ...You MUST set non-zero min gas prices in app.toml. Query umeed q ugov min-gas-price to...


Near line 51: Possible spelling mistake found.
Context: ...ero min gas prices in app.toml. Query umeed q ugov min-gas-price to see what is th...


Near line 60: Possible spelling mistake found.
Context: ...Joining the network Before joining the mainnet you should join a testnet! ### Testnet...


Near line 60: Possible spelling mistake found.
Context: ...e joining the mainnet you should join a testnet! ### Testnet 1. Make sure you can run...


Near line 64: Possible spelling mistake found.
Context: ... ### Testnet 1. Make sure you can run umeed and price-feeder locally. 2. Join th...


Near line 65: Possible spelling mistake found.
Context: ....gg/4ZJAFvg9). Make sure you are in the Testnet group. 3. Follow the state sync [canon-...


Near line 67: Possible spelling mistake found.
Context: ...You can use the following peers in your config.toml: ```toml persistent_peers = "ee...


Near line 73: Possible spelling mistake found.
Context: ... one of the UX Team members to send you testnet uumee. 6. Once your node validator is...


Near line 73: Possible spelling mistake found.
Context: ...the UX Team members to send you testnet uumee. 6. Once your node validator is set up...


Near line 75: Possible spelling mistake found.
Context: ...e Feeder is running correctly. If your [testnet window misses](https://canon.price-feed...


Near line 75: Please check whether ‘widow’ (woman whose husband is dead) might be the correct word here instead of ‘window’.
Context: ... is running correctly. If your [testnet window misses](https://canon.price-feeder.com/...


Near line 77: Possible spelling mistake found.
Context: ...ok for a help on Discord. Here are our testnet public endpoints: - [Explorer](https:/...


Near line 85: Possible spelling mistake found.
Context: ...e sure you firstly tested your setup on Testnet. 2. Use one of the community [snapshots...


Near line 87: Possible spelling mistake found.
Context: ...pshots/tree/main/Projects/Umee). 3. Buy uumee to self delegate. 4. Make sure your Pr...


Near line 88: Possible spelling mistake found.
Context: ...e Feeder is running correctly. If your [mainnet window misses](https://price-feeder.com...


Near line 88: Please check whether ‘widow’ (woman whose husband is dead) might be the correct word here instead of ‘window’.
Context: ... is running correctly. If your mainnet window misses are ...


Near line 90: Possible spelling mistake found.
Context: ... help on Discord. We recommend to use Cosmovisor for mainnet n...


Near line 90: Possible spelling mistake found.
Context: ...osmovisor](../README.md#cosmovisor) for mainnet nodes.

Additional comments not posted (2)
docs/VALIDATOR.md (2)

46-46: Clarify the geographical restrictions on endpoints.

Please specify which regions commonly have blocked endpoints or provide a link to a resource where users can check if their region is affected. This will enhance the clarity and usefulness of the documentation.


47-47: Update Discord links to ensure they are accessible.

Please verify that the provided Discord links are accessible and direct users to the correct channels. This is crucial for ensuring that validators can receive timely updates and support.


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.

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 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.

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

CodeRabbit Configration 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
Collaborator

@gsk967 gsk967 left a comment

Choose a reason for hiding this comment

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

LGTM

@robert-zaremba robert-zaremba added this pull request to the merge queue Apr 24, 2024
Merged via the queue into main with commit 30a4b43 Apr 24, 2024
21 of 22 checks passed
@robert-zaremba robert-zaremba deleted the robert/val-docs branch April 24, 2024 22:38
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