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
5 changes: 5 additions & 0 deletions .codespell_exclude_lines.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,8 @@ Refer to the MKE product documentation for information about working with MKE.
$ checkmodule -m -M -o nvidia-container-microshift.mod nvidia-container-microshift.te
2023/06/22 14:25:38 Retreiving plugins.
* Restored Azure Kubernetes Service (AKS) to the :ref:`cloud service providers <cloud-service-providers>` table.
- page: Azure AKS
## About MKE with the GPU Operator
## Approaches for Working with Azure AKS
## Verifying MKE with the GPU Operator
title: "Azure AKS"
22 changes: 22 additions & 0 deletions fern/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# GPU Operator navigation drafts for Fern

Two drafts of the same content, organized with the patterns in "Landing Page and Navigation Patterns for Docs in Fern".
Page titles and section headings come from the cloud-native-docs RST. Page bodies are stubs.

- `a-simple-product/`: Simple Product. Three peer Books as header tabs: GPU Operator, OpenShift, Partner-Validated.
- `b-complex-product/`: Complex Product. Category tabs: Guides, Reference, Release Notes, Troubleshooting, Support Matrix. The Guides tab has a Book menu: Install and Upgrade, Advanced Configuration, Sandboxed Workloads, OpenShift, Partner Platforms.

Both drafts show a version picker with 26.7, 26.3, and 25.10. All three versions use the same navigation.

## Run a draft

Requires Node.js 18 or later.

```bash
npm install -g fern-api@5.213.0
cd a-simple-product/fern && fern docs dev --port 3000
cd b-complex-product/fern && fern docs dev --port 3001
```

Open http://localhost:3000 and http://localhost:3001.

35 changes: 35 additions & 0 deletions fern/assets/NVIDIA_dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions fern/assets/NVIDIA_light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions fern/assets/NVIDIA_symbol.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
instances:
- url: nvidia.docs.buildwithfern.com/gpu-operator-b
title: NVIDIA GPU Operator
layout:
searchbar-placement: header
page-width: 1376px
sidebar-width: 248px
content-width: 812px
tabs-placement: header
hide-feedback: true
colors:
accentPrimary:
dark: '#76B900'
light: '#245501'
logo:
dark: ./assets/NVIDIA_dark.svg
light: ./assets/NVIDIA_light.svg
height: 20
right-text: GPU Operator
favicon: ./assets/NVIDIA_symbol.svg
css:
- ./main.css
navbar-links:
- type: github
value: https://github.com/NVIDIA/gpu-operator
versions:
- display-name: '26.7'
path: ./versions/v26.7.yml
slug: '26.7'
- display-name: '26.3'
path: ./versions/v26.7.yml
slug: '26.3'
- display-name: '25.10'
path: ./versions/v26.7.yml
slug: '25.10'
1 change: 1 addition & 0 deletions fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"organization": "nvidia", "version": "5.213.0"}
73 changes: 73 additions & 0 deletions fern/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/* Larger type across the site: body copy and sidebar. */

.fern-prose,
.prose {
font-size: 1.0625rem !important; /* 17px */
line-height: 1.7 !important;
}

.fern-sidebar-link,
.fern-sidebar-heading {
font-size: 0.9375rem !important; /* 15px */
}


/* Landing page (pages/overview/index.mdx, layout: custom). */

.cc-landing {
max-width: 1040px;
margin: 0 auto;
padding: 0 1.5rem 4rem;
}

.cc-hero {
padding: 4rem 0 2.5rem;
text-align: center;
}

.cc-eyebrow {
margin: 0 0 0.75rem;
font-size: 0.8125rem;
font-weight: 600;
letter-spacing: 0.12em;
text-transform: uppercase;
color: #76B900;
}

.cc-hero h1 {
margin: 0;
font-size: clamp(1.875rem, 3.5vw, 2.5rem);
line-height: 1.2;
font-weight: 600;
}

.cc-lede {
max-width: 640px;
margin: 1rem auto 0;
font-size: 1.125rem;
line-height: 1.6;
opacity: 0.75;
}

.cc-products {
margin-bottom: 3.5rem;
}

.cc-products .fern-card {
padding: 1.5rem;
transition: transform 120ms ease, border-color 120ms ease;
}

.cc-products .fern-card:hover {
transform: translateY(-3px);
border-color: #76B900;
}

.cc-landing h2 {
margin: 2.5rem 0 1rem;
font-size: 0.875rem;
font-weight: 600;
letter-spacing: 0.08em;
text-transform: uppercase;
opacity: 0.7;
}
39 changes: 39 additions & 0 deletions fern/pages/config/cdi.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "CDI and NRI Support"
---

<Info>Navigation draft. The page body is a stub. Source: `gpu-operator/cdi.rst`.</Info>

Placeholder introduction for the page.

## About Container Device Interface (CDI)

Placeholder section text.

## Enabling CDI

Placeholder section text.

## Disabling CDI

Placeholder section text.

## About the Node Resource Interface (NRI) Plugin

Placeholder section text.

## Enabling the NRI Plugin

Placeholder section text.

## Disabling the NRI Plugin

Placeholder section text.

## Requesting CDI Devices with the NRI Plugin

Placeholder section text.

## Known Issues

Placeholder section text.
11 changes: 11 additions & 0 deletions fern/pages/config/custom-driver-params.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Custom GPU Driver Parameters"
---

<Info>Navigation draft. The page body is a stub. Source: `gpu-operator/custom-driver-params.rst`.</Info>

Placeholder introduction for the page.

## Configure Custom Driver Parameters

Placeholder section text.
55 changes: 55 additions & 0 deletions fern/pages/config/dra-intro-install.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "DRA Driver for NVIDIA GPUs"
---

<Info>Navigation draft. The page body is a stub. Source: `gpu-operator/dra-intro-install.rst`.</Info>

Placeholder introduction for the page.

## Comparison: DRA and Device Plugin

Placeholder section text.

## Overview

Placeholder section text.

## Prerequisites

Placeholder section text.

## Install

Placeholder section text.

## Configure DRA Components

Placeholder section text.

## Validate Installation

Placeholder section text.

## Running a Sample Workload

Placeholder section text.

## Telemetry

Placeholder section text.

## Upgrade

Placeholder section text.

## Uninstall

Placeholder section text.

## Troubleshooting

Placeholder section text.

## Additional Documentation

Placeholder section text.
35 changes: 35 additions & 0 deletions fern/pages/config/gpu-operator-mig.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "Multi-Instance GPU (MIG)"
---

<Info>Navigation draft. The page body is a stub. Source: `gpu-operator/gpu-operator-mig.rst`. Also absorbs `kubernetes/index.rst` (MIG Support in Kubernetes) and the shared `mig/` pages.</Info>

Placeholder introduction for the page.

## About Multi-Instance GPU

Placeholder section text.

## Enabling MIG During Installation

Placeholder section text.

## Configuring MIG Profiles

Placeholder section text.

## Verification: Running Sample CUDA Workloads

Placeholder section text.

## Disabling MIG

Placeholder section text.

## MIG Manager with Preinstalled Drivers

Placeholder section text.

## Architecture

Placeholder section text.
Loading
Loading