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: Node operator doc fixes #1771

Merged
merged 16 commits into from
Aug 16, 2024

Conversation

PhilippGackstatter
Copy link

@PhilippGackstatter PhilippGackstatter commented Aug 13, 2024

Description of change

Proofread the node operator section. Deduplicates the validator task file which existed in the wiki and in the nre directory within the repo (thanks @lucas-tortora).

A local self-compiled network was successfully setup following the instructions in the wiki pages.
The docker, ansible and systemd setup was NOT tested. It seems much more appropriate for someone from DevOps to check these since they have the most experience with node deployment and operation. They can also better decide whether we want to support all of those configurations or perhaps only the docker one, for example.

Tasks that weren't possible to do in this PR or follow-up tasks from this PR are documented in #1867.

Links to any relevant issues

fixes #1290

@PhilippGackstatter PhilippGackstatter added the sc-platform Issues related to the Smart Contract Platform group. label Aug 13, 2024
@PhilippGackstatter PhilippGackstatter marked this pull request as ready for review August 15, 2024 10:09
@PhilippGackstatter PhilippGackstatter requested review from a team as code owners August 15, 2024 10:09
@fijter fijter added the devx Issues related to the DevX team label Aug 15, 2024
Copy link
Contributor

@fijter fijter left a comment

Choose a reason for hiding this comment

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

Good improvements, thanks a lot :)

Wondering if we should just comment out the TODO URL sections for now or leave them there with the TODO urls.

nre/iota_for_node_operators.md Outdated Show resolved Hide resolved
nre/iota_for_node_operators.md Outdated Show resolved Hide resolved
@PhilippGackstatter PhilippGackstatter force-pushed the vm-language/feat/operator-docs-updates branch from 7f8a1b5 to 0ebcc59 Compare August 15, 2024 13:23
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@PhilippGackstatter
Copy link
Author

This PR is ready to be merged but for some reason the docs-lint and docusaurus job do not start.

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@Thoralf-M
Copy link
Member

@PhilippGackstatter repo settings need to be updated to require the correct job, I asked Thomas to update

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@PhilippGackstatter PhilippGackstatter merged commit 83a7a7c into develop Aug 16, 2024
24 checks passed
@PhilippGackstatter PhilippGackstatter deleted the vm-language/feat/operator-docs-updates branch August 16, 2024 16:21
bingyanglin pushed a commit that referenced this pull request Aug 19, 2024
* fix(docs): Replace "a IOTA" with "an IOTA"

* fix(docs): Typos and incorrect URLs in full node config

* fix(docs): Update staking numbers and fix style

* fix(nre): Fix typos, style and urls in node operator guide

* fix(docs): Fix data management typos and content

* fix(docs): Typos and style fixes in snapshots

* feat(devx): poc import config READMEs in wiki while keeping the READMEs valid

* fix(docs): Proofread node tools

* fix(docs): Rename tasks section to operation

* fix(docs): Proofread node monitoring

* fix(docs): Comment out TODO URLs

* fix(docs): dprint fmt

* refactor(docs): Pull validator tool into wiki as well

---------

Co-authored-by: Lucas Tortora <[email protected]>
Co-authored-by: Thoralf-M <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Issues related to the DevX team sc-platform Issues related to the Smart Contract Platform group.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task (Docs)] Proof-read and improve Node Operators section, test out node setup
4 participants