Skip to content

docs: fill documentation gaps on clusters, swap, Mattermost - #255

Merged
DavidePrincipi merged 4 commits into
mainfrom
docs-gap-1
Aug 3, 2026
Merged

docs: fill documentation gaps on clusters, swap, Mattermost#255
DavidePrincipi merged 4 commits into
mainfrom
docs-gap-1

Conversation

@DavidePrincipi

Copy link
Copy Markdown
Member

Summary

  • Clarify that distinct NS8 clusters cannot be merged, and that only individual applications can be migrated between clusters via backup/restore (mind the UUID constraint).
  • Clarify that a removed node must be finalized (shutdown or uninstalled) before its applications can be safely restored elsewhere, and document the uninstall anchor/behavior for reusing a node.
  • Explain how to resize NS8 swap space, pointing to the official RHEL 9 swap guide (also valid for Debian), and warn about the /swapfile name clash.
  • Document how to reset a lost Mattermost admin/user password with mmctl user change-password --local, and why the email-based reset-password command doesn't help without SMTP configured.

Related issue

None — ad-hoc documentation gaps identified during review.

How to test

Read through the updated sections in:

  • docs/administrator-manual/configuration/cluster.md
  • docs/administrator-manual/installation/install.md
  • docs/administrator-manual/installation/system_requirements.md
  • docs/administrator-manual/applications/mattermost.md

@DavidePrincipi DavidePrincipi self-assigned this Jul 30, 2026
github-actions Bot pushed a commit that referenced this pull request Jul 30, 2026
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-08-03 10:45 UTC

@DavidePrincipi

Copy link
Copy Markdown
Member Author

⚠️ Automated translation is incomplete, cluster.md is missing /cc @m-dilorenzi

https://github.com/NethServer/ns8-docs/actions/runs/30563335708/job/91101730322

@gsanchietti gsanchietti 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.

Align Italian translation

Explain that distinct clusters cannot be merged and that only
individual applications can be migrated via backup/restore, mind
the UUID constraint. Also clarify that a removed node must be
finalized (shutdown or uninstalled) before its applications can be
restored elsewhere, and document the uninstall anchor/behavior used
to reuse a node after removal.

Assisted-by: Claude:claude-sonnet-5
Point to the official RHEL 9 swap guide, which also covers Debian,
and warn that its examples reuse the /swapfile name NS8 sets up by
default.

Assisted-by: Claude:claude-sonnet-5
Explain how to recover a lost Mattermost admin or user password
with mmctl change-password, and note why the email-based
reset-password command does not apply without SMTP configured.

Assisted-by: Claude:claude-sonnet-5
Mirror the cluster merging, node reuse, swap resize, and Mattermost
password reset content added to the English docs.

Assisted-by: Claude:claude-sonnet-5
@DavidePrincipi
DavidePrincipi merged commit fc8bfe8 into main Aug 3, 2026
2 checks passed
@DavidePrincipi
DavidePrincipi deleted the docs-gap-1 branch August 3, 2026 10:45
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.

3 participants