Skip to content

improve(docs): [part 2] further node operator docs improvements #6365

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

Merged
merged 64 commits into from
Apr 29, 2025

Conversation

gokhan-simsek-iota
Copy link
Contributor

@gokhan-simsek-iota gokhan-simsek-iota commented Apr 11, 2025

Description of change

Second part of further improvements to node/validator operator docs.
(First part: #6031)

Changes apart from the issues in the next section:

  • Improve monitoring page by using snippets for validator/full node (was one common page before, and showing incorrect content for validator)
  • Improvements for setups/fullnode/systemd/setup.sh script
  • Improvements for docs/content/operator/full-node/docker.mdx

Links to any relevant issues

Partially solves #6017.
Specifically these issues:

Type of change

Choose a type of change, and delete any options that are not relevant.

  • Documentation Fix

How the change has been tested

Run docs locally:

cd docs

// one time only cmds
pnpm install
pnpm iota-docs build

pnpm iota-docs dev

// forward port 3000 in vscode ports tab when necessary 

Src: https://github.com/iotaledger/iota/tree/develop/docs

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code

Copy link

vercel bot commented Apr 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
apps-backend ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2025 9:40am
apps-ui-kit ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2025 9:40am
rebased-explorer ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2025 9:40am
wallet-dashboard ⬜️ Ignored (Inspect) Visit Preview Apr 29, 2025 9:40am

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 11, 2025
@iota-ci iota-ci added core-protocol node Issues related to the Core Node team labels Apr 11, 2025
@gokhan-simsek-iota gokhan-simsek-iota force-pushed the docs/further-part-2-node-operator-docs-improvements branch from 3c97265 to 23f6348 Compare April 16, 2025 15:07
@github-actions github-actions bot added the ci Issues related to our CI pipeline label Apr 23, 2025
@nmrshll nmrshll linked an issue Apr 23, 2025 that may be closed by this pull request
@muXxer muXxer marked this pull request as draft April 25, 2025 14:25
@muXxer muXxer force-pushed the docs/further-part-2-node-operator-docs-improvements branch 6 times, most recently from ffbfe6b to 087ebb4 Compare April 25, 2025 14:52
@muXxer muXxer force-pushed the docs/further-part-2-node-operator-docs-improvements branch from 087ebb4 to 9905ebf Compare April 25, 2025 15:00
@nmrshll
Copy link
Contributor

nmrshll commented Apr 25, 2025

@gokhan-simsek-iota we had a call to review the PR, the fullnode-docker-setup archive workflow is now completely overhauled, and we fixed the instruction docs to match

@nmrshll nmrshll marked this pull request as ready for review April 25, 2025 15:43
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@alexsporn alexsporn merged commit 635a3af into develop Apr 29, 2025
31 checks passed
@alexsporn alexsporn deleted the docs/further-part-2-node-operator-docs-improvements branch April 29, 2025 10:04
state-archive-read-config:
- object-store-config:
object-store: "GCS"
# Use iota-mainnet-archive for mainnet
Copy link
Collaborator

@junwei0117 junwei0117 Apr 29, 2025

Choose a reason for hiding this comment

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

we are not using GCS at the moment, we should clarify it

object-store: "S3"
# Use iota-testnet-archive for testnet
# Use iota-mainnet-archive for mainnet
bucket: "iota-<testnet|mainnet>-archive"
Copy link
Collaborator

Choose a reason for hiding this comment

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

we are not using AWS S3 for public archive usage. users need to use aws-endpoint instead and enable virtual-hosted style. you can refer to this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Issues related to our CI pipeline core-protocol documentation Improvements or additions to documentation node Issues related to the Core Node team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add workflow to create pre-packed zip files with different setups
6 participants