Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/scripts/check_aliases.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')}"
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions CSV-TABLE-SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down Expand Up @@ -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
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALETutorials/Storage/ManagePoolsScale.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/SCALEUIReference/Storage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
Expand Down
2 changes: 1 addition & 1 deletion content/SCALE/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ h1 {display:none;}
<div class="docs-sections">
<p>
<a href="/scale/gettingstarted/" style="font-size:18px;">Getting Started Guide</a>
<br><a href="/scale/gettingstarted/scalereleasenotes/">Development Notes</a>
<br><a href="/scale/gettingstarted/versionnotes/">Development Notes</a>
<br><a href="/scale/gettingstarted/scalehardwareguide/">Community Hardware Guide</a>
<br><a href="/scale/gettingstarted/install/">Software Install</a>
<br><a href="/scale/gettingstarted/migrate/">Migrating from CORE</a>
Expand Down
6 changes: 3 additions & 3 deletions data/properties/scale-releases.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
2 changes: 1 addition & 1 deletion layouts/shortcodes/section-cards.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</div>
<div class="section-tab-content" id="scale-next" style="display:none;">
<a href="/scale/">25.10 (Early Development)</a>
<br><a href="/scale/gettingstarted/scalereleasenotes/">25.10 Development Notes</a>
<br><a href="/scale/gettingstarted/versionnotes/">25.10 Development Notes</a>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion release-summary/25.10-BETA.1.release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)**
**[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/)**
6 changes: 3 additions & 3 deletions release-summary/release-summary-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

**Pre-Update Actions:** <Any required preparation steps>

**[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/)**


<!-- .1/.2/.3 -->
Expand All @@ -26,7 +26,7 @@

**Pre-Update Actions:** <Any required preparation steps>

**[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/)**


<!-- HOTFIX -->
Expand All @@ -37,4 +37,4 @@

**Pre-Update Actions:** <Any required preparation steps>

**[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/)**
4 changes: 2 additions & 2 deletions static/js/csv-changelog-init.js
Original file line number Diff line number Diff line change
Expand Up @@ -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/
}
Expand Down
4 changes: 2 additions & 2 deletions static/js/csv-changelog-table.js
Original file line number Diff line number Diff line change
Expand Up @@ -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/
}
Expand Down
2 changes: 1 addition & 1 deletion static/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
1 change: 1 addition & 0 deletions words-to-ignore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,7 @@ Resilvering
interruptable
Ahrens
scalenextversion
versionnotes
scalereleasenotes
ManageLocalUsersSCALE
iso
Expand Down