Skip to content

README.md

Latest commit

 

History

History
67 lines (48 loc) · 3.85 KB

README.md

File metadata and controls

67 lines (48 loc) · 3.85 KB
Raw

NVIDIA CCluster Docs

This repository contains the Fern source for the NVIDIA CCluster documentation site, published at docs.nvidia.com/ccluster.

The site uses the NVIDIA global theme (global-theme: nvidia), so logo, colors, fonts, layout, and footer come from the shared global-theme repository rather than this repo. See the NVIDIA Fern onboarding guide for platform details.

Repository Layout

  • fern/fern.config.json: Fern organization (nvidia) and pinned CLI version
  • fern/docs.yml: hosting, custom domain, theme, navbar links, and the left-nav structure (page order, slugs, sidebar icons)
  • fern/redirects.yml: redirects for renamed or removed pages
  • docs/: all documentation pages, written as .mdx
    • docs/home/: landing pages (introduction, quickstart)
    • docs/apps/: deployment product docs (LLM serving, inference, compute, jobs)
    • docs/clients/: SDK and client setup docs
    • docs/resources/: supporting guides (custom images, vault, service accounts, etc.)
    • docs/<section>/images/: screenshots used by the pages in that section
  • tools/: MDX-safety and docs-path checkers run in CI
  • .github/workflows/: Fern check, PR preview, and publish workflows

Prerequisites

  • Node.js 22 or higher
  • Fern CLI: npm install -g fern-api
  • Optional: fern login --email <your-nvidia-email> to apply the NVIDIA theme in local previews and enable the missing-redirects check

Local Development

Start the dev server with hot-reload:

fern docs dev

Then open http://localhost:3000/ccluster. Without fern login (or FERN_TOKEN), the preview renders unthemed.

Validation

Run the same checks as CI before opening a PR:

fern check
fern docs md check
fern docs broken-links --strict
python3 tools/check-docs-mdx docs/
python3 tools/check-docs-paths --allow '../docs/' docs fern

Editing Workflow

  1. Update or add .mdx pages under the appropriate directory in docs/.
  2. Add new pages to the navigation section of fern/docs.yml with a ../docs/<section>/<page>.mdx path; only pages listed there are published.
  3. Put images in the section's images/ folder and reference them with ./images/... paths. Absolute paths and .. segments are rejected by tools/check-docs-paths; the only exception is the ../docs/ prefix of page paths in fern/docs.yml.
  4. Use Fern's built-in components (Card, CardGroup, Frame, Note, Tip, and others). Icons are Font Awesome classes such as fa-solid fa-lock.
  5. Link between pages with root-relative paths such as /apps/llm; Fern adds the /ccluster base path.

Release Process

Publishing runs through GitHub Actions and needs the FERN_TOKEN repository secret (request one in #cdd-fern).

Workflow Trigger Result
check-docs.yml PRs and pushes to main Validates config, MDX, links, and docs paths
preview-docs.yml Same-repo PRs Posts a Fern preview link on the PR
publish-docs.yml Merge to main that changes docs/ or fern/, or manual run Publishes production after the checks pass

Connecting the Fern site to docs.nvidia.com/ccluster requires a review and Jira ticket from the Developer Experience team; ask in #cdd-fern.