docs: add changelog - #3637
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
Summary by CodeRabbit
WalkthroughThe documentation now publishes dated releases through a unified changelog, updates v2.0 navigation and redirects, removes legacy release-note references, revises release guidance, and expands Fern preview collection for MDX and REST API documentation. ChangesChangelog publication migration
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/ok to test |
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3637.docs.buildwithfern.com/infra-controller Here are the markdown pages you've updated: |
🔐 TruffleHog Secret Scan✅ No secrets or credentials found! Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉 🕐 Last updated: 2026-07-17 01:30:26 UTC | Commit: 36d2643 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@fern/changelog/2026-07-31.mdx`:
- Around line 39-44: Update the v0.8 upgrade steps to explicitly document the
--skip-rest cutover gate: run ./setup.sh --skip-rest to provision prerequisites
and External Secrets, quiesce REST writes, restore nico_rest, then rerun
./setup.sh without --skip-rest so the REST chart and migration job start only
after restoration.
- Around line 1-7: Remove or defer the 2026-07-31 changelog entry so it is not
present in fern until the release date; keep the NVIDIA Infra Controller v2.0
content unchanged when it is reintroduced for publication.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 956d2c58-ea5d-407d-9277-26c956d38b0e
📒 Files selected for processing (12)
docs/.rumdl.tomldocs/development/release_and_qa_process.mddocs/index.mddocs/index.ymldocs/release-notes.mdfern/changelog/2026-01-23.mdxfern/changelog/2026-02-12.mdxfern/changelog/2026-05-15.mdxfern/changelog/2026-07-31.mdxfern/changelog/overview.mdxfern/docs.ymlrest-api/CHANGELOG.md
💤 Files with no reviewable changes (1)
- docs/release-notes.md
|
/ok to test |
|
Looks fine to me, are we planning on the GitHub release description (i.e. the native GitHub release) to link to the Fern docs? Also I assume that the content for v2.0 isn't ready yet, because we shipped way more stuff than NTP containers :) |
We should link each to the other, yes.
You assume correctly! I'm going to back that out, actually, and replace it with a "forthcoming" note. I wanted to have something in there to look at, and this was easier than Lorem Ipsum! |
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
…and REST DB consolidation (#1) Co-authored-by: Alex Ball <aball@nvidia.com> Signed-off-by: Shayan Namaghi <snamaghi@nvidia.com>
c139595 to
b2f6d7d
Compare
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/fern-docs-preview-build.yml:
- Line 67: Update the changed-markdown discovery command in the workflow to stop
interpolating github.base_ref directly in the shell; expose it through the
step’s env configuration and reference the resulting quoted shell variable,
following the existing DEFAULT_BRANCH pattern. Preserve the current git diff
behavior and error handling.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 5ea6e57e-40c1-45d3-92b0-cc57ab6382bb
📒 Files selected for processing (1)
.github/workflows/fern-docs-preview-build.yml
|
/ok to test |
thossain-nv
added
the
rest-api
ChatGPT Codex Connector
Signed-off-by: Alex Ball <aball@nvidia.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
fern/changelog/2026-07-31.mdx (2)
5-9: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDo not label the unreleased entry as
Current.As of July 29, 2026, this entry says v2.0 is scheduled for release later in July and is dated July 31, 2026. Use an
Upcoming/Forthcomingbadge until publication, then change it toCurrent.Proposed adjustment
-## NVIDIA Infra Controller v2.0 <Badge intent="launch">Current</Badge> +## NVIDIA Infra Controller v2.0 <Badge intent="launch">Upcoming</Badge>🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@fern/changelog/2026-07-31.mdx` around lines 5 - 9, Update the badge on the “NVIDIA Infra Controller v2.0” changelog heading to use the repository’s Upcoming or Forthcoming intent while the release remains scheduled, and reserve the Current badge for after publication.
27-29: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument the upstream NTP defaults explicitly.
nico-ntp.ntp.upstreamServersdefaults to a list oftime1.google.comthroughtime4.google.com; the brace form reads like shorthand, not a Helm value list, and can mislead operators.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@fern/changelog/2026-07-31.mdx` around lines 27 - 29, Update the NTP documentation in the changelog entry to explicitly list the four default upstream servers as time1.google.com, time2.google.com, time3.google.com, and time4.google.com instead of using brace notation, while preserving the existing override guidance for nico-ntp.ntp.upstreamServers.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@fern/changelog/2026-07-31.mdx`:
- Around line 5-9: Update the badge on the “NVIDIA Infra Controller v2.0”
changelog heading to use the repository’s Upcoming or Forthcoming intent while
the release remains scheduled, and reserve the Current badge for after
publication.
- Around line 27-29: Update the NTP documentation in the changelog entry to
explicitly list the four default upstream servers as time1.google.com,
time2.google.com, time3.google.com, and time4.google.com instead of using brace
notation, while preserving the existing override guidance for
nico-ntp.ntp.upstreamServers.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: fa362a4b-d85b-407f-a651-ca6c2e3f2f1f
📒 Files selected for processing (2)
docs/index.mdfern/changelog/2026-07-31.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/index.md
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/fern-docs-preview-build.yml:
- Around line 61-62: Update the workflow environment block containing BASE_REF
and DEFAULT_BRANCH to also define HEAD_REF from github.head_ref, then change the
shell usage at the affected run command to echo the quoted HEAD_REF variable
instead of interpolating github.head_ref directly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 7b29e1a8-4780-4316-91d0-1a7192bcb1f9
📒 Files selected for processing (5)
.github/workflows/fern-docs-preview-build.ymlfern/changelog/2026-01-23.mdxfern/changelog/2026-02-12.mdxfern/changelog/2026-05-15.mdxfern/changelog/2026-07-31.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- fern/changelog/2026-01-23.mdx
- fern/changelog/2026-05-15.mdx
- fern/changelog/2026-07-31.mdx
nv-dmendoza
left a comment
nv-dmendoza
left a comment
There was a problem hiding this comment.
LGTM, comments are suggestions to consider
| | **End-of-Life (EOL)** | Two minors back (`v2.0`) | No | Unsupported. No further releases will be cut on this branch | | ||
| | Tier | Which release | Bug fixes? | Notes | | ||
| | ---- | ------------- | ---------- |-------| | ||
| | **Current** | The newest GA minor (for example, `v2.2`) | Yes — normal bar | Recommended for production deployments. **No new feature work lands here** — new features land in `main` and ship in the next minor release. Small, low-risk improvements can occasionally be backported alongside bug fixes. | |
There was a problem hiding this comment.
i think e.g. was better here, less words, same effect on clarity
5 participants
This change replaces the release notes with a changelog.
👉 The link for the release notes is now in the left nav, directly below Home.
For more information on the approach, refer to Fern's documentation on changelogs is here, and have a look at their own changelog.
This brings some advantages over a monolithic file, particularly if we're going to continue on a monthly release cadence:
Note: Adding some MDX files exposed a couple of small issues in the Fern preview pipeline. Adding that fix has triggered a required review from the CI/CD maintainers.
Type of Change
Breaking Changes
Testing