Skip to content

Refresh private deployment docs and fix the broken admin guide link - #4161

Draft
roman-khimov with Copilot wants to merge 3 commits into
masterfrom
copilot/fix-outdated-deploy-doc
Draft

Refresh private deployment docs and fix the broken admin guide link#4161
roman-khimov with Copilot wants to merge 3 commits into
masterfrom
copilot/fix-outdated-deploy-doc

Conversation

Copilot AI commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

The private deployment guide had drifted from the current neofs-adm workflow, and the admin docs contained a broken relative link to the deployment page.

  • Overview

    • Refreshes the stale bare-metal deployment guidance so it matches the current private-network bootstrap flow and removes outdated version-specific instructions.
    • Fixes the broken documentation link from docs/cli-adm.md to the deployment guide.
  • Changes

    • Updated docs/deploy.md to reflect the current sequence: create config, generate alphabet wallets, launch consensus/Alphabet nodes, create a storage wallet, start the storage node, and trigger a new epoch when needed.
    • Reworked the surrounding narrative to describe the actual neofs-adm behavior without the older, harder-edged setup steps that no longer match the project.
    • Corrected the relative link in docs/cli-adm.md so it points to deploy.md reliably.
  • Example

[Read step-by-step guide of private storage deployment](deploy.md)

Copilot AI linked an issue Aug 31, 2026 that may be closed by this pull request
Co-authored-by: roman-khimov <22092804+roman-khimov@users.noreply.github.com>
Copilot AI changed the title [WIP] Update deploy.md with current deployment scheme Refresh private deployment docs and fix the broken admin guide link Aug 31, 2026
Copilot AI requested a review from roman-khimov August 31, 2026 16:22
Comment thread docs/cli-adm.md
## Private network deployment

Read step-by-step guide of private storage deployment [in docs](./deploy.md).
Read step-by-step guide of private storage deployment [in docs](deploy.md).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Unrelated change.

Comment thread docs/deploy.md
Comment thread docs/deploy.md Outdated
With default 15 seconds per block, 240 blocks are going to be a 1-hour epoch.
The epoch duration should match the expected block generation rate in the N3
sidechain. With the default 15 seconds per block, 240 blocks is roughly one
hour.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Epoch duration is set in seconds for a long time, block time is irrelevant.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Clarified that epoch_duration is a block count, not a block-time recommendation; the guide now describes it in those terms.

Comment thread docs/deploy.md Outdated
Comment thread docs/deploy.md Outdated
Comment thread docs/deploy.md
```

Configure the Storage node to use this wallet.
The generated wallet file can then be used by the Storage node configuration.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

SN address should have some GAS to be able to register in the network. See dev-env or AIO.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Added the note that the storage node wallet must have enough GAS to register, matching the bootstrap expectations used by the dev environment examples.

@roman-khimov

Copy link
Copy Markdown
Member

@copilot, fix review comments

@roman-khimov roman-khimov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot, fix review comments

@roman-khimov roman-khimov left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot, fix review comments

Co-authored-by: roman-khimov <22092804+roman-khimov@users.noreply.github.com>
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.

Outdated deploy.md

2 participants