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: documentation for docker node #92

Closed

Conversation

JeancarloBarrios
Copy link
Contributor

@JeancarloBarrios JeancarloBarrios commented Oct 24, 2023

Motivation

Add documentation for running a node, manually or with Docker.

Explanation of Changes

(Write your explanation here)

Testing

(Write your test plan here)

Related PRs and Issues

(Link your related PRs and Issues here)
ref: #93

@JeancarloBarrios JeancarloBarrios marked this pull request as ready for review October 27, 2023 16:57
Copy link
Contributor

@gluax gluax left a comment

Choose a reason for hiding this comment

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

I didn't do a grammar/spelling check yet. But some initial comments.

I also opine that running a node should be a section in our readme right after the installation section. A long readme is ok, especially when its for users imo.


When connecting externally, choose a trustworthy node operator. Unscrupulous operators might tamper with query outcomes or block transactions. The Seda team currently supports these RPC endpoints:

- Mainnet (seda-1): `https://rpc.sedaprotocol-domian.io:443`
Copy link
Contributor

Choose a reason for hiding this comment

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

Invalid url.

When connecting externally, choose a trustworthy node operator. Unscrupulous operators might tamper with query outcomes or block transactions. The Seda team currently supports these RPC endpoints:

- Mainnet (seda-1): `https://rpc.sedaprotocol-domian.io:443`
- Testnet (ares-1): `https://testnet-rpc.sedaprotocol-domain.io:443`
Copy link
Contributor

Choose a reason for hiding this comment

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

ares-1? also invalid link


Seda-chaind, often referred to as the "seda-chain daemon", is the primary command-line tool for interfacing with the Seda blockchain. It's the go-to tool for all node managers and validators.

## Setting Up Environment Variables
Copy link
Contributor

Choose a reason for hiding this comment

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

The golang and make instructions should be in the developing readme for developers only. We already have some there as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think validators should still have the option to build from source. It is a good idea to add a special command in make with the static linking. But their instructions should include building from source.

Copy link
Contributor

Choose a reason for hiding this comment

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

We already have them, though! We can just say if you want to build from source, please check out our developing.md. No need to duplicate instructions :).

seda-chaind init join <MONIKER> --network <NETWORK_ID> --recover
```
Moniker ID for your node
(Where network can be: devnet,...)
Copy link
Contributor

Choose a reason for hiding this comment

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

We should have a list of network_id somewhere in the readme. instead of just a ().


## Initializing Your Node

Once you've installed seda-chaind, kickstart your node with the command:
Copy link
Contributor

Choose a reason for hiding this comment

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

We need installation docs outside of make for non devs. Since we now have the release page on github this could be done.

seda-chaind start
```

# Docker Setup
Copy link
Contributor

Choose a reason for hiding this comment

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

I would re-order these a bit.

These instructions should be in our base readme Installation section where you can list multiple sections that link to the docker section and the installation section from github releases.

@gluax
Copy link
Contributor

gluax commented Oct 30, 2023

I also invite @Thomasvdam @mariocao to look at my comments and make sure I'm not saying anything too crazy haha

@gluax
Copy link
Contributor

gluax commented Nov 1, 2023

Closed, and being done in #102.

@gluax gluax closed this Nov 1, 2023
@hacheigriega hacheigriega deleted the JeancarloBarrios/documentation-for-docker-node branch May 2, 2024 16:05
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