Skip to content

Conversation

micjohnson777
Copy link
Contributor

This PR updates the Rsync tutorial content with the new UI screen elements and processes in 25.10. It also updates out of date content in the AddSSHConnectionKeyPair.md tutorial.

Backports to 25.10.

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

Added changes based on the way the Advanced Replication Creation button operates, and fixed a few descriptions for screens and settings that needed clarifications.
This commit updates the language about switching between the wizard and add task screen to remove duplication.
This commit updates the ReplicationScreensSCALE.md article with new or changed definitions, and updates the BasicReplicationProcess.md snippet by breaking the local and remote overviews into individual sections, and updates each step to reflect the current processes
This commit rewrites the RemoteReplicationSCALE.md tutorial, using new snippets to streamline the process to set up replication tasks.
This commit includes a grammar/spelling check and makes a few minor changes where needed.
This commit updates the LocalReplicationSCALE.md tutorial to use the new snippets

Renames the ReplicationWizardSteps4Thru6.md to ReplicationWizardSteps5And6.md, which moves the Replicate Custom Snapshot content up to step 4 and makes it part of the base content in the RemoteReplicationSCALE.md tutorial. It does not apply to local replication.
Update the AdvancedReplication/_index.md file content to work with the changed BasicReplicationProcess.md snippet.
This commit makes changes to the tutorial for replication using encryption. It removes the old procedure and updates with a referal to the RemoteReplicationSCALE.md tutorial, and updates that tutorial with the optional encryption setting. It removes duplicated content and focuses the article on replication and encryption options.
Added information about the connection after it is added in TrueNAS.
…ntent

This commit updates the RsyncTasksSCALE.md tutorial content to reflect changes in the UI and the processes for Module mode and SSH mode with the new connection options.
This commit updates the user update information in the AddSSHConnectionKeyPair.md tutorial, and adds the AddSSHConnection.md snippet to section on creating a connection. It also runs a grammar/spell check on the content.
@micjohnson777 micjohnson777 requested a review from a team as a code owner October 2, 2025 17:59
@bugclerk bugclerk changed the title Pd 2265 update rsync UI ref and tutorial content PD-2265 / 26.04 / Pd 2265 update rsync UI ref and tutorial content Oct 2, 2025
@bugclerk
Copy link
Contributor

bugclerk commented Oct 2, 2025

This comment was marked as duplicate.

@linzi-ix linzi-ix added the Technical Writer Review (LM) A technical writer is reviewing the PR. label Oct 7, 2025
Copy link
Contributor

@linzi-ix linzi-ix left a comment

Choose a reason for hiding this comment

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

Minor typos corrected, several conflicts need fixing in the merge editor

Copy link

github-actions bot commented Oct 9, 2025

Vale Style Guide Issues

📊 Summary: 104 issues found in changed files - 6 errors, 5 warnings, 93 suggestions

Changed files with issues:

content/SCALE/SCALETutorials/DataProtection/RsyncTasksSCALE.md (60 issues)

  • Lines 3, 21, 22, 23, 27, 33, 75, 105, 122, 126, 127, 133, 140, 155, 156, 163, 164, 179, 200 - suggestion: Avoid contractions in formal writing
  • Lines 3, 33, 37, 41, 46, 50, 52, 102, 106, 126, 128, 129, 155 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 34, 39 - warning: Avoid using 'user's'
  • Lines 44, 102 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 52 - suggestion: Spell out 'SSS' on first use
  • Lines 75, 77, 102, 108 - suggestion: Keep sentences under 30 words
  • Line 126 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 168 - suggestion: Verify your use of 'Allow' with the A-Z word list.

content/SCALE/SCALETutorials/Credentials/BackupCredentials/AddSSHConnectionKeyPair.md (44 issues)

  • Lines 2, 3, 19, 21, 23, 35, 38, 39, 46, 47, 54, 56, 62, 77, 82, 84 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 21, 39 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 23, 40, 46, 47, 58, 66 - suggestion: Avoid contractions in formal writing
  • Line 48 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 54 - suggestion: Keep sentences under 30 words
  • Line 84 - suggestion: Spell out 'NAS' on first use
  • Line 88 - suggestion: Spell out 'RSA' on first use
  • Line 89 - warning: Remove 'generally' if it's not important to the meaning of the statement.
  • Line 89 - suggestion: Spell out 'SFTP' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@linzi-ix linzi-ix merged commit 578b70e into master Oct 9, 2025
5 checks passed
@linzi-ix linzi-ix deleted the PD-2265-Update-Rsync-UI-ref-and-Tutorial-Content branch October 9, 2025 15:01
@bugclerk
Copy link
Contributor

bugclerk commented Oct 9, 2025

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.

@truenas truenas locked as resolved and limited conversation to collaborators Oct 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants