Consolidate node documentation #739

janewang · 2021-06-07T16:41:32Z

Move all node related docs into the same dir
Fix links
Update sidebar
WIP: Need more info for RPC and Validator node

* Move all node related docs into the same dir * Fix links * Update sidebar * WIP: Need more info for RPC and Validator node

render · 2021-06-07T16:43:33Z

Your Render PR Server URL is https://docs-pr-739.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-c2v4pbu31hs7pm2ggj70.

janewang · 2021-06-07T17:08:24Z

CI test-link is complaining about broken links on master, not the feature branch ¯\_(ツ)_/¯.

bowenwang1996

Great work 🚀 🚀 🚀

docs/develop/node/community/node-community-updates.md

docs/develop/node/intro/types-of-node.md

docs/develop/node/maintenance/maintenance.md

thisisjoshford · 2021-06-07T19:39:22Z

CI test-link is complaining about broken links on master, not the feature branch ¯_(ツ)_/¯.

Just migrated to a new CI link checking solution and did not whitelist the 'EDIT' button (instant PR) in the upper right hand corner when creating new pages. Just pushed a fix and will merge it with this branch that should solve these 404 errors.

* Clarify to the reader that using `nearup` is for `testnet` and `betanet` * Renaming files for better readability * Add SEO description for node spin command pages

…olidate-node-doc

…rs are over 100GB

janewang

@bowenwang1996 @frol @mikedotexe @chefsale @mhalambek @thisisjoshford

Hi All, I've split the Node Hardware Requirements into Minimal Specifications and Recommended Specifications for Validator, RPC, and Archival. For Minimal, we'd like to keep the requirements as low as reasonably possible. Could you please take a look and comment on these. Thanks!

frol

@janewang Enormous work! 😍

frol · 2021-06-09T20:00:48Z

docs/develop/node/community/node-community-updates.md

+2. Bugs and feature enhancements are tracked in the Github project tracker [`Node Experience`](https://github.com/orgs/near/projects/18). Node operators are welcome to create new issues for features and bugs, and to add these issues into the [Github project tracker](https://github.com/orgs/near/projects/18).
+    - **New feature / Enhancement requests:**  
+        - Please create a [`Github issue`](https://github.com/near/nearcore/issues)
+        - Tag `nodeX`
+        - Filter them through `Incoming Requests` column in the Github project tracker [`Node Experience`](https://github.com/orgs/near/projects/18), where they will be groomed and moved into `Backlog` based on priority
+    - **Bug reports:**
+        - Please create a [`Github issue`](https://github.com/near/nearcore/issues)
+        - Tag `nodeX` and `Bug`
+        - Put it at the top of the `Incoming Requests` column for more immediate attention in the Github project tracker [`Node Experience`](https://github.com/orgs/near/projects/18)


non-NEAR members cannot label issues or move issues on those boards. We need to create GitHub templates with the pre-set labels to let people create the issues with the specific labels.

frol · 2021-06-09T20:13:36Z

docs/develop/node/intro/what-is-a-node.md

+You may decide to run a node of your own for a few reasons:
+
+- To join a network as a validator running a "validator node". Running a validator node is a public good and you are effectively securing the NEAR network and earning rewards.
+- To develop and deploy contracts on a node connected to `MainNet`, `TestNet` or `BetaNet` (†)


I don't see it to be a good reason to run your own node. I think it is better to say something along these lines:

To run applications that heavily depend on RPC performance and/or availability.

The cost ranges from 0.10-0.35 cents depending on tyoe of SSDs which are used across providers. For 1.5TB the cost would be somewhere 150-500 dollars depending on setup.

Yes!
@chefsale May I please have some guidance and ballpark cost estimation numbers on hardware costs:

Validator node cost estimate: https://docs.near.org/docs/develop/node/validator/hardware
RPC node cost estimate: https://docs.near.org/docs/develop/node/rpc/hardware-rpc
Archival node cost estimate: https://docs.near.org/docs/develop/node/archival/hardware-archival - Is the storage cost of $150-$500 a monthly figure?

Thanks!

frol · 2021-06-09T20:15:49Z

docs/develop/node/intro/what-is-a-node.md

+
+_( † ) `TestNet` is intended to operate as similarly to `MainNet`  as possible with only stable releases while `BetaNet` follows a weekly release cycle._
+
+_( †† ) `LocalNet` would be the right choice if you prefer to avoid leaking information about your work during the development process since `TestNet` and `BetaNet` are *public* networks. `LocalNet` also gives you total control over accounts, economics and other factors for more advanced use cases (ie. making changes to `nearcore`)._


I believe we stick to lowercase naming (testnet, betanet, localnet), please, double-check with @bowenwang1996 and @thisisjoshford

I believe we stick to lowercase naming (testnet, betanet, localnet), please, double-check with @bowenwang1996 and @thisisjoshford

Yes, I was thinking of the same naming convention while reading the docs. Sometimes they are TitleCase, sometimes camelCase, and sometimes lowercase. In code, they seem to be consistently lowercase. I will convert all to lowercase for consistency.

frol · 2021-06-09T20:25:13Z

docs/develop/node/validator/running-a-node-macos-linux.md

->Got a question?
-<a href="https://stackoverflow.com/questions/tagged/nearprotocol">
-  <h8>Ask it on StackOverflow!</h8></a>


Is there a better way to get in touch? I believe StackOverflow is the best wiki platform

Is there a better way to get in touch? I believe StackOverflow is the best wiki platform

Is the case that most questions for validators are posted on StackOverflow? Do the core team actively monitor Stackoverflow?

cc @bowenwang1996 @frol @mikedotexe

Here are some ways recommended to get in touch. Please let me know StackOverflow fits in here too, and I can add back the footer if StackOverflow is actively used:
https://docs.near.org/docs/develop/node/community/node-community-updates

It is ideal if people get in touch through StackOverflow. We have the integration that pushes SO questions to Slack, and we keep the questions answered most of the time: https://stackoverflow.com/questions/tagged/nearprotocol

Ooh, neato, I will add it back. Also thanks for commenting on Stackoverflow!

chefsale · 2021-06-09T21:01:24Z

@janewang I just wanted to mention that the cost for disk cost for archival nodes seems very very low. Not sure how we got the numbers, but the calculations I made are in hundreds of dollars. We have to take into account that we are using SSDs instead of regular HDDs. We should update that. cc: @frol @bowenwang1996

chefsale · 2021-06-09T21:06:42Z

The cost ranges from 0.10-0.35 cents depending on tyoe of SSDs which are used across providers. For 1.5TB the cost would be somewhere 150-500 dollars depending on setup.

Consolidate node documentation

e913cde

* Move all node related docs into the same dir * Fix links * Update sidebar * WIP: Need more info for RPC and Validator node

janewang linked an issue Jun 7, 2021 that may be closed by this pull request

[DOC] Consolidate documentation on running a node #735

Closed

bowenwang1996 reviewed Jun 7, 2021

View reviewed changes

thisisjoshford and others added 9 commits June 7, 2021 12:39

Merge branch 'master' of github.com:near/docs into consolidate-node-doc

a8c89c3

Address comments and add some SEO descriptions

879b262

More cleanup for node spin up commands

0797149

* Clarify to the reader that using `nearup` is for `testnet` and `betanet` * Renaming files for better readability * Add SEO description for node spin command pages

Merge branch 'master' of github.com:near/docs into consolidate-node-doc

c688a0a

Merge branch 'consolidate-node-doc' of github.com:near/docs into cons…

958bad9

…olidate-node-doc

Merge branch 'master' into consolidate-node-doc

d4de84e

Add more info for node community

593a777

Increase hardware storage requirement as current storage for validato…

9cc36e9

…rs are over 100GB

Add hardware requirements for RPC and Archival nodes

374d114

janewang commented Jun 8, 2021

View reviewed changes

bowenwang1996 approved these changes Jun 8, 2021

View reviewed changes

janewang merged commit 3859db2 into master Jun 8, 2021

janewang deleted the consolidate-node-doc branch June 8, 2021 16:31

thisisjoshford mentioned this pull request Jun 9, 2021

revised running a node #476

Closed

frol reviewed Jun 9, 2021

View reviewed changes


		_( † ) `TestNet` is intended to operate as similarly to `MainNet` as possible with only stable releases while `BetaNet` follows a weekly release cycle._

		_( †† ) `LocalNet` would be the right choice if you prefer to avoid leaking information about your work during the development process since `TestNet` and `BetaNet` are public networks. `LocalNet` also gives you total control over accounts, economics and other factors for more advanced use cases (ie. making changes to `nearcore`)._

Consolidate node documentation #739

Consolidate node documentation #739

Uh oh!

Conversation

janewang commented Jun 7, 2021

Uh oh!

render bot commented Jun 7, 2021

Uh oh!

janewang commented Jun 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bowenwang1996 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thisisjoshford commented Jun 7, 2021

Uh oh!

janewang left a comment

Choose a reason for hiding this comment

Uh oh!

frol left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

janewang Jun 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chefsale commented Jun 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chefsale commented Jun 9, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

janewang commented Jun 7, 2021 •

edited

Loading

janewang Jun 10, 2021 •

edited

Loading

chefsale commented Jun 9, 2021 •

edited

Loading