Skip to content

Conversation

bugclerk
Copy link
Contributor

@bugclerk bugclerk commented Oct 9, 2025

Automatic cherry-pick failed. Please resolve conflicts by running:

git reset --hard HEAD~1
git cherry-pick -x bc11936e180a00f689c9ea338188a9a8b13e472f
git cherry-pick -x c320b9cb46dea784185dfe0602d406500c63ba4c
git cherry-pick -x 71693136cf444773846d2f883b9b5707a27eca5e
git cherry-pick -x 143f805a47b82d28d4531147c6dddc7bf67f68ed
git cherry-pick -x 46e5c0654d09ef18f11cddb9efc74666a211911f
git cherry-pick -x 9cb85bb3ccade3f74a665a7602c8b1267d1e6845
git cherry-pick -x 953506c6a3af0b3ad77633d0a1cd51bda1229b2e
git cherry-pick -x 64df63d75a50206d2aea0ea050f300729b3ae684
git cherry-pick -x e2cbdab57391759f5567bbce925871caaeede128
git cherry-pick -x 4f9503df0de899f3b1b4c51c6b26fa02ef575960
git cherry-pick -x f01758664a2c6d85e2eac81741f3c2487f4a89cb
git cherry-pick -x 04343c24fbca8273a68dc8a78847f0c506ee74e4
git cherry-pick -x 7bdc269d1574836d646e22abea5f1a4c745afdcf
git cherry-pick -x 5d690d6921affeaff5eddb6fc5b42ac64ba05a18
git cherry-pick -x 32d7ff4f7c770dc0ce973b9e2767a0f16a310e57
git cherry-pick -x e13e63edf688ce5e1a80dc05b85d980241367581
git cherry-pick -x 0d57b739bfee4b828678abc8263a5b96ad39dc35
git cherry-pick -x d238c135b93a210fcd65c08296d7ae1c659602ac
git cherry-pick -x a5e1cd3adbac45952f9636c65e1b826ddea2eeda

If the original PR was merged via a squash, you can just cherry-pick the squashed commit:

git reset --hard HEAD~1
git cherry-pick -x 578b70e9fa3cda4c2fbc5a8521cef719609016f0

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.

Original PR: #4200
Jira URL: https://ixsystems.atlassian.net/browse/PD-2265

micjohnson777 and others added 5 commits October 9, 2025 11:27
…4200)

* PD-2218 Update Replication UI Ref

Added changes based on the way the Advanced Replication Creation button operates, and fixed a few descriptions for screens and settings that needed clarifications.

* PD-2218 Update Language about switching  between screens

This commit updates the language about switching between the wizard and add task screen to remove duplication.

* PD-2218 Replication Updates

initial changes

* PD-2218 Update UI ref and main replication tutorial index

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

* PD-2218 Create New Snippets Rewrite Remote Replication

This commit rewrites the RemoteReplicationSCALE.md tutorial, using new snippets to streamline the process to set up replication tasks.

* PD-2218 Grammer, Spelling, and Content check

This commit includes a grammar/spelling check and makes a few minor changes where needed.

* PD-2218 Update Local Replication Tutorial

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.

* PD-2218 Save changes not in previous commit

* PD-2218 Saves changes in Remote Replication not in the two previous commits

* PD-2218 Update Advanced Replication

Update the AdvancedReplication/_index.md file content to work with the changed BasicReplicationProcess.md snippet.

* PD-2218 Update the ReplicationWithEncryptionSCALE.md Tutorial

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.

* PD-2218 Update the AddSSHConnection.md snippet

Added information about the connection after it is added in TrueNAS.

* PD-2265 Update Branch and Update the Rsync  task and SSH Connection content

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.

* PD-2265 Update the AddSSSHConnectionKeyPair.md tutorial

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.

* Update ReplicationScheduleAndRetentionSteps.md

---------

Co-authored-by: linzibelle <[email protected]>
(cherry picked from commit 578b70e)
…4200)

* PD-2218 Update Replication UI Ref

Added changes based on the way the Advanced Replication Creation button operates, and fixed a few descriptions for screens and settings that needed clarifications.

* PD-2218 Update Language about switching  between screens

This commit updates the language about switching between the wizard and add task screen to remove duplication.

* PD-2218 Replication Updates

initial changes

* PD-2218 Update UI ref and main replication tutorial index

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

* PD-2218 Create New Snippets Rewrite Remote Replication

This commit rewrites the RemoteReplicationSCALE.md tutorial, using new snippets to streamline the process to set up replication tasks.

* PD-2218 Grammer, Spelling, and Content check

This commit includes a grammar/spelling check and makes a few minor changes where needed.

* PD-2218 Update Local Replication Tutorial

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.

* PD-2218 Save changes not in previous commit

* PD-2218 Saves changes in Remote Replication not in the two previous commits

* PD-2218 Update Advanced Replication

Update the AdvancedReplication/_index.md file content to work with the changed BasicReplicationProcess.md snippet.

* PD-2218 Update the ReplicationWithEncryptionSCALE.md Tutorial

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.

* PD-2218 Update the AddSSHConnection.md snippet

Added information about the connection after it is added in TrueNAS.

* PD-2265 Update Branch and Update the Rsync  task and SSH Connection content

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.

* PD-2265 Update the AddSSSHConnectionKeyPair.md tutorial

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.

* Update ReplicationScheduleAndRetentionSteps.md

---------

Co-authored-by: linzibelle <[email protected]>
(cherry picked from commit 578b70e)
…4200)

* PD-2218 Update Replication UI Ref

Added changes based on the way the Advanced Replication Creation button operates, and fixed a few descriptions for screens and settings that needed clarifications.

* PD-2218 Update Language about switching  between screens

This commit updates the language about switching between the wizard and add task screen to remove duplication.

* PD-2218 Replication Updates

initial changes

* PD-2218 Update UI ref and main replication tutorial index

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

* PD-2218 Create New Snippets Rewrite Remote Replication

This commit rewrites the RemoteReplicationSCALE.md tutorial, using new snippets to streamline the process to set up replication tasks.

* PD-2218 Grammer, Spelling, and Content check

This commit includes a grammar/spelling check and makes a few minor changes where needed.

* PD-2218 Update Local Replication Tutorial

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.

* PD-2218 Save changes not in previous commit

* PD-2218 Saves changes in Remote Replication not in the two previous commits

* PD-2218 Update Advanced Replication

Update the AdvancedReplication/_index.md file content to work with the changed BasicReplicationProcess.md snippet.

* PD-2218 Update the ReplicationWithEncryptionSCALE.md Tutorial

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.

* PD-2218 Update the AddSSHConnection.md snippet

Added information about the connection after it is added in TrueNAS.

* PD-2265 Update Branch and Update the Rsync  task and SSH Connection content

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.

* PD-2265 Update the AddSSSHConnectionKeyPair.md tutorial

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.

* Update ReplicationScheduleAndRetentionSteps.md

---------

Co-authored-by: linzibelle <[email protected]>
(cherry picked from commit 578b70e)
@micjohnson777 micjohnson777 marked this pull request as ready for review October 9, 2025 15:35
@micjohnson777 micjohnson777 requested a review from a team as a code owner October 9, 2025 15:35
@micjohnson777
Copy link
Contributor

Had to run the cherry pick a few times before it showed the changed files but it is good to go now.,

Copy link

github-actions bot commented Oct 9, 2025

Vale Style Guide Issues (Previous - Click to expand)
Vale Style Guide Issues (Previous - Click to expand)
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

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

Changed files with issues:

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

  • Lines 3, 20, 21, 22, 26, 32, 74, 104, 121, 125, 126, 132, 139, 154, 155, 162, 163, 178, 199 - suggestion: Avoid contractions in formal writing
  • Lines 3, 32, 36, 40, 45, 49, 51, 101, 105, 125, 127, 128, 154 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 33, 38 - warning: Avoid using 'user's'
  • Lines 43, 101 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 51 - suggestion: Spell out 'SSS' on first use
  • Lines 74, 76, 101, 107 - suggestion: Keep sentences under 30 words
  • Line 125 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 167 - suggestion: Verify your use of 'Allow' with the A-Z word list.

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

  • Lines 2, 3, 18, 20, 22, 34, 37, 38, 45, 46, 53, 55, 61, 76, 81, 83 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 20, 38 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 22, 39, 45, 46, 57, 65 - suggestion: Avoid contractions in formal writing
  • Line 47 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 53 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Spell out 'NAS' on first use
  • Line 87 - suggestion: Spell out 'RSA' on first use
  • Line 88 - warning: Remove 'generally' if it's not important to the meaning of the statement.
  • Line 88 - suggestion: Spell out 'SFTP' on first use

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

Copy link

github-actions bot commented Oct 9, 2025

Vale Style Guide Issues (Previous - Click to expand)
Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

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

Changed files with issues:

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

  • Lines 3, 20, 21, 22, 26, 32, 74, 104, 121, 125, 126, 132, 139, 154, 155, 162, 163, 178, 199 - suggestion: Avoid contractions in formal writing
  • Lines 3, 32, 36, 40, 45, 49, 51, 101, 105, 125, 127, 128, 154 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 33, 38 - warning: Avoid using 'user's'
  • Lines 43, 101 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 51 - suggestion: Spell out 'SSS' on first use
  • Lines 74, 76, 101, 107 - suggestion: Keep sentences under 30 words
  • Line 125 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 167 - suggestion: Verify your use of 'Allow' with the A-Z word list.

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

  • Lines 2, 3, 18, 20, 22, 34, 37, 38, 45, 46, 53, 55, 61, 76, 81, 83 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 20, 38 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 22, 39, 45, 46, 57, 65 - suggestion: Avoid contractions in formal writing
  • Line 47 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 53 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Spell out 'NAS' on first use
  • Line 87 - suggestion: Spell out 'RSA' on first use
  • Line 88 - warning: Remove 'generally' if it's not important to the meaning of the statement.
  • Line 88 - suggestion: Spell out 'SFTP' on first use

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

Copy link
Contributor

@DjP-iX DjP-iX left a comment

Choose a reason for hiding this comment

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

Either the image needs to be moved to match the path or the path needs to be updated to match the actual image location. This needs to be corrected on the master branch too.

Edit the admin account. Select the user, and click **Edit** to open the **Edit User** screen.

{{< trueimage src="/images/SCALE/Credentials/SSHEditUserAuthenticationSettings.png" alt="Add SSH Key" id="Add SSH Key" >}}
{{< trueimage src="/images/SCALE/Credentials/EditUserFullAdminSSHAccess.png" alt="Adding SSH Settings" id="Adding SSH Settings" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Broken Image

@DjP-iX DjP-iX added the Technical Writer Review (DP) A technical writer is reviewing the PR. label Oct 9, 2025
Copy link

github-actions bot commented Oct 9, 2025

Vale Style Guide Issues (Previous - Click to expand)

Vale Style Guide Issues

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

Changed files with issues:

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

  • Lines 3, 20, 21, 22, 26, 32, 74, 104, 121, 125, 126, 132, 139, 154, 155, 162, 163, 178, 199 - suggestion: Avoid contractions in formal writing
  • Lines 3, 32, 36, 40, 45, 49, 51, 101, 105, 125, 127, 128, 154 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 33, 38 - warning: Avoid using 'user's'
  • Lines 43, 101 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 51 - suggestion: Spell out 'SSS' on first use
  • Lines 74, 76, 101, 107 - suggestion: Keep sentences under 30 words
  • Line 125 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 167 - suggestion: Verify your use of 'Allow' with the A-Z word list.

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

  • Lines 2, 3, 18, 20, 22, 34, 37, 38, 45, 46, 53, 55, 61, 76, 81, 83 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 20, 38 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 22, 39, 45, 46, 57, 65 - suggestion: Avoid contractions in formal writing
  • Line 47 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 53 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Spell out 'NAS' on first use
  • Line 87 - suggestion: Spell out 'RSA' on first use
  • Line 88 - warning: Remove 'generally' if it's not important to the meaning of the statement.
  • Line 88 - suggestion: Spell out 'SFTP' on first use

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

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/SCALETutorials/DataProtection/RsyncTasksSCALE.md (60 issues)

  • Lines 3, 20, 21, 22, 26, 32, 74, 104, 121, 125, 126, 132, 139, 154, 155, 162, 163, 178, 199 - suggestion: Avoid contractions in formal writing
  • Lines 3, 32, 36, 40, 45, 49, 51, 101, 105, 125, 127, 128, 154 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 33, 38 - warning: Avoid using 'user's'
  • Lines 43, 101 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 51 - suggestion: Spell out 'SSS' on first use
  • Lines 74, 76, 101, 107 - suggestion: Keep sentences under 30 words
  • Line 125 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 167 - suggestion: Verify your use of 'Allow' with the A-Z word list.

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

  • Lines 2, 3, 18, 20, 22, 34, 37, 38, 45, 46, 53, 55, 61, 76, 81, 83 - suggestion: Use proper formatting: bold for UI elements, italics for variables, backticks for commands
  • Lines 20, 38 - suggestion: Verify your use of 'allow' with the A-Z word list.
  • Lines 22, 39, 45, 46, 57, 65 - suggestion: Avoid contractions in formal writing
  • Line 47 - suggestion: Verify your use of 'allows' with the A-Z word list.
  • Line 53 - suggestion: Keep sentences under 30 words
  • Line 83 - suggestion: Spell out 'NAS' on first use
  • Line 87 - suggestion: Spell out 'RSA' on first use
  • Line 88 - warning: Remove 'generally' if it's not important to the meaning of the statement.
  • Line 88 - suggestion: Spell out 'SFTP' on first use

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

@DjP-iX DjP-iX merged commit d722862 into 25.10 Oct 9, 2025
4 checks passed
@DjP-iX DjP-iX deleted the PD-2265-25.10 branch October 9, 2025 17:02
@bugclerk
Copy link
Contributor Author

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.
Labels
Technical Writer Review (DP) A technical writer is reviewing the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants