diff --git a/.github/scripts/check_aliases.py b/.github/scripts/check_aliases.py index 877f80525e..bbb82b4cf8 100644 --- a/.github/scripts/check_aliases.py +++ b/.github/scripts/check_aliases.py @@ -6,8 +6,11 @@ # Match any path containing a version-like segment: /12.34/ version_pattern = re.compile(r"/\d{2}\.\d{2}/") -# Allowed exception pattern -exception_pattern = re.compile(r"^/scale/\d{2}\.\d{2}/gettingstarted/scalereleasenotes/?$") +# Allowed exception patterns +exception_patterns = [ + re.compile(r"^/scale/\d{2}\.\d{2}/gettingstarted/versionnotes/?$"), + re.compile(r"^/scale/\d{2}\.\d{2}/gettingstarted/scalereleasenotes/?$") +] # Get list of changed files compared to the base branch base_branch = f"origin/{os.environ.get('GITHUB_BASE_REF', 'master')}" @@ -33,7 +36,7 @@ aliases = data.get("aliases", []) for alias in aliases: - if version_pattern.search(alias) and not exception_pattern.match(alias): + if version_pattern.search(alias) and not any(pattern.match(alias) for pattern in exception_patterns): violations.append(f"{file}: contains forbidden alias: {alias}") except Exception as e: diff --git a/CSV-TABLE-SETUP.md b/CSV-TABLE-SETUP.md index 335c2f61d3..7ad4be82a6 100644 --- a/CSV-TABLE-SETUP.md +++ b/CSV-TABLE-SETUP.md @@ -9,7 +9,7 @@ Your CSV changelog table is now ready with version support and automated generat - ✅ **Version configuration**: `/static/data/changelog-versions.json` - ✅ **Version support**: Multiple CSV files per release version - ✅ **Automated generation**: Script to combine individual releases -- ✅ **Integration**: Added to `SCALEReleaseNotes.md` with version selector +- ✅ **Integration**: Added to `VersionNotes.md` with version selector ### 2. **Version Configuration** @@ -96,7 +96,7 @@ This will automatically: #### **Step D: Update Documentation Pages** Update your release notes page to use the new version: ```javascript -// In your release notes page (e.g., SCALEReleaseNotes.md) +// In your release notes page (e.g., VersionNotes.md) initializeChangelogTableForTabs('25.10'); // Matches the key in changelog-versions.json ``` diff --git a/content/SCALE/GettingStarted/SCALEReleaseNotes.md b/content/SCALE/GettingStarted/VersionNotes.md similarity index 97% rename from content/SCALE/GettingStarted/SCALEReleaseNotes.md rename to content/SCALE/GettingStarted/VersionNotes.md index 6b765ae47b..2d3992845e 100644 --- a/content/SCALE/GettingStarted/SCALEReleaseNotes.md +++ b/content/SCALE/GettingStarted/VersionNotes.md @@ -9,6 +9,8 @@ aliases: - /scalenext-releasenotes/ - /scale/scalenextversion/ - /scale/26.04/gettingstarted/scalereleasenotes/ + - /scale/26.04/gettingstarted/versionnotes/ + - /scale/gettingstarted/scalereleasenotes/ - /releasenotes/ jump_to_buttons: - text: "Latest Changes" @@ -37,7 +39,7 @@ jump_to_buttons: {{< hint type="tip" title="26.04 Nightly Development Documentation" >}} This page tracks the latest development roadmap and notes for the future TrueNAS major version 26.04 (Halfmoon). -See the stable [25.04 (Fangtooth)](https://www.truenas.com/docs/scale/25.04/gettingstarted/scalereleasenotes/) or pre-release [25.10 (Goldeye)](https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/) release notes for information relating to those versions. +See the stable [25.04 (Fangtooth)](https://www.truenas.com/docs/scale/25.04/gettingstarted/scalereleasenotes/) or pre-release [25.10 (Goldeye)](https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/) release notes for information relating to those versions. {{< /hint >}} ## Notable Changes and Known Issues diff --git a/content/SCALE/SCALETutorials/Storage/ManagePoolsScale.md b/content/SCALE/SCALETutorials/Storage/ManagePoolsScale.md index b7322dfa4d..6792a8d66b 100644 --- a/content/SCALE/SCALETutorials/Storage/ManagePoolsScale.md +++ b/content/SCALE/SCALETutorials/Storage/ManagePoolsScale.md @@ -64,7 +64,7 @@ Upgrading a storage pool is typically not required unless the new OpenZFS featur Do not do a pool-wide ZFS upgrade until you are ready to commit to this TrueNAS major version! You can not undo a pool upgrade, and you lose the ability to roll back to an earlier major version! -The **Upgrade** button displays on the **Storage Dashboard** for existing pools after an upgrade to a new TrueNAS major version that includes new [OpenZFS feature flags]({{< ref "SCALEReleaseNotes.md#component-versions" >}}). +The **Upgrade** button displays on the **Storage Dashboard** for existing pools after an upgrade to a new TrueNAS major version that includes new [OpenZFS feature flags]({{< ref "VersionNotes.md#component-versions" >}}). Newly created pools are always up to date with the OpenZFS feature flags available in the installed TrueNAS version. {{< trueimage src="/images/SCALE/Storage/StorageDashboardUpgradPoolConfirmationDialog.png" alt="Upgrade Pool Confirmation Dialog" id="Upgrade Pool Confirmation Dialog" >}} diff --git a/content/SCALE/SCALEUIReference/Storage/_index.md b/content/SCALE/SCALEUIReference/Storage/_index.md index 6da333d2d5..f8a4ab608b 100644 --- a/content/SCALE/SCALEUIReference/Storage/_index.md +++ b/content/SCALE/SCALEUIReference/Storage/_index.md @@ -306,7 +306,7 @@ TrueNAS complies with SAS/SATA specifications and reports temperatures in Celsiu ## Upgrade Dialog -The **Storage Dashboard** shows the **Upgrade** button for existing pools after an upgrade to a new TrueNAS release that includes new [OpenZFS feature flags]({{< ref "SCALEReleaseNotes.md#component-versions" >}}). +The **Storage Dashboard** shows the **Upgrade** button for existing pools after an upgrade to a new TrueNAS release that includes new [OpenZFS feature flags]({{< ref "VersionNotes.md#component-versions" >}}). Newly created pools are always up-to-date with the OpenZFS feature flags in the installed TrueNAS release. {{< include file="/static/includes/UpgradePools.md" >}} diff --git a/content/SCALE/_index.md b/content/SCALE/_index.md index ce7cfe0dcc..bf8620633c 100644 --- a/content/SCALE/_index.md +++ b/content/SCALE/_index.md @@ -36,7 +36,7 @@ h1 {display:none;}

Getting Started Guide -
Development Notes +
Development Notes
Community Hardware Guide
Software Install
Migrating from CORE diff --git a/data/properties/scale-releases.yaml b/data/properties/scale-releases.yaml index 66b29a98f2..ba18c83833 100644 --- a/data/properties/scale-releases.yaml +++ b/data/properties/scale-releases.yaml @@ -29,12 +29,12 @@ majorVersions: releases: - name: "25.10-RC.1" type: "Early" - link: "https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/#25.10-RC.1" + link: "https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/#25.10-RC.1" releaseDate: "2025-09-30" latest: true - name: "25.10 Nightlies" type: "Experimental" - link: "https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/" + link: "https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/" releaseDate: "2025-01-27" latest: false - lifecycle: "Preview" @@ -43,6 +43,6 @@ majorVersions: releases: - name: "26.04 Nightlies" type: "Experimental" - link: "https://www.truenas.com/docs/scale/26.04/gettingstarted/scalereleasenotes/" + link: "https://www.truenas.com/docs/scale/26.04/gettingstarted/versionnotes/" releaseDate: "2025-08-11" latest: false diff --git a/layouts/shortcodes/section-cards.html b/layouts/shortcodes/section-cards.html index 344151653a..a0fd5b02c8 100644 --- a/layouts/shortcodes/section-cards.html +++ b/layouts/shortcodes/section-cards.html @@ -22,7 +22,7 @@

diff --git a/release-summary/25.10-BETA.1.release-notes.md b/release-summary/25.10-BETA.1.release-notes.md index a361d377bb..39579b7aed 100644 --- a/release-summary/25.10-BETA.1.release-notes.md +++ b/release-summary/25.10-BETA.1.release-notes.md @@ -14,4 +14,4 @@ This includes OS component updates, new features for Community and Enterprise en **Pre-Update Actions:** Verify installed Nvidia GPU is supported by the [XX.XX.XX nvidia driver](), change Directory Services idmap_autorid option. -**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/)** | **[Known Issues Link](https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/#2510beta1-known-issues)** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** \ No newline at end of file +**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/)** | **[Known Issues Link](https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/#2510beta1-known-issues)** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** \ No newline at end of file diff --git a/release-summary/release-summary-template.md b/release-summary/release-summary-template.md index 43719e8718..00e2752e47 100644 --- a/release-summary/release-summary-template.md +++ b/release-summary/release-summary-template.md @@ -12,7 +12,7 @@ **Pre-Update Actions:** -**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/)** | **[Known Issues Link]()** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** +**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/)** | **[Known Issues Link]()** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** @@ -26,7 +26,7 @@ **Pre-Update Actions:** -**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/)** | **[Known Issues Link]()** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** +**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/)** | **[Known Issues Link]()** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** @@ -37,4 +37,4 @@ **Pre-Update Actions:** -**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/scalereleasenotes/)** | **[Known Issues Link]()** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** \ No newline at end of file +**[Detailed Release Notes](https://www.truenas.com/docs/scale/25.10/gettingstarted/versionnotes/)** | **[Known Issues Link]()** | **[Enterprise Support](https://support.ixsystems.com/)** | **[Community Forums](https://forums.truenas.com/)** \ No newline at end of file diff --git a/static/js/csv-changelog-init.js b/static/js/csv-changelog-init.js index b8afd2c9a0..40d2732191 100644 --- a/static/js/csv-changelog-init.js +++ b/static/js/csv-changelog-init.js @@ -31,12 +31,12 @@ async function initializeChangelogFromConfig(baseUrl, containerId, majorVersion, // Check if the segment after 'scale' looks like a version (e.g., "25.10") const potentialVersion = pathSegments[scaleIndex + 1]; if (potentialVersion && /^\d+\.\d+/.test(potentialVersion)) { - // Versioned branch: docs/scale/25.10/gettingstarted/scalereleasenotes/ + // Versioned branch: docs/scale/25.10/gettingstarted/versionnotes/ // Need to go back to version root (docs/scale/25.10/) const versionIndex = scaleIndex + 1; // Index of version segment (25.10) docsRootDepth = pathSegments.length - versionIndex - 1; // Back to docs/scale/25.10/ } else { - // Master branch: docs/scale/gettingstarted/scalereleasenotes/ + // Master branch: docs/scale/gettingstarted/versionnotes/ // Need to go back to scale root (docs/scale/) docsRootDepth = pathSegments.length - scaleIndex - 1; // Back to docs/scale/ } diff --git a/static/js/csv-changelog-table.js b/static/js/csv-changelog-table.js index 631bc8e6c5..f12f4f8a44 100644 --- a/static/js/csv-changelog-table.js +++ b/static/js/csv-changelog-table.js @@ -35,12 +35,12 @@ async function createCSVChangelogTable(baseUrlOrSingleUrl, containerId, options // Check if the segment after 'scale' looks like a version (e.g., "25.10") const potentialVersion = pathSegments[scaleIndex + 1]; if (potentialVersion && /^\d+\.\d+/.test(potentialVersion)) { - // Versioned branch: docs/scale/25.10/gettingstarted/scalereleasenotes/ + // Versioned branch: docs/scale/25.10/gettingstarted/versionnotes/ // Need to go back to version root (docs/scale/25.10/) const versionIndex = scaleIndex + 1; // Index of version segment (25.10) docsRootDepth = pathSegments.length - versionIndex - 1; // Back to docs/scale/25.10/ } else { - // Master branch: docs/scale/gettingstarted/scalereleasenotes/ + // Master branch: docs/scale/gettingstarted/versionnotes/ // Need to go back to scale root (docs/scale/) docsRootDepth = pathSegments.length - scaleIndex - 1; // Back to docs/scale/ } diff --git a/static/llms.txt b/static/llms.txt index 013cedfa24..fcbf907a6a 100644 --- a/static/llms.txt +++ b/static/llms.txt @@ -83,7 +83,7 @@ The TrueNAS documentation includes two main content types for each version: ### Development Content (Nightly/Unstable) - TrueNAS 25.10 Development Content: https://truenas.com/docs/scale/ -- Latest Development Features: https://truenas.com/docs/scale/gettingstarted/scalereleasenotes/ +- Latest Development Features: https://truenas.com/docs/scale/gettingstarted/versionnotes/ ## TrueNAS 25.04 (Current Stable - Default) diff --git a/words-to-ignore.txt b/words-to-ignore.txt index 337f519dbe..8f5175083e 100644 --- a/words-to-ignore.txt +++ b/words-to-ignore.txt @@ -469,6 +469,7 @@ Resilvering interruptable Ahrens scalenextversion +versionnotes scalereleasenotes ManageLocalUsersSCALE iso