Skip to content

Commit c59faed

Browse files
committed
docs: reorganize documentation by persona
Rename documentation directories to align with user personas: - docs/architecture → docs/contributor - docs/integration → docs/integrator - docs/user-guide → docs/user - docs/demos → examples/demos Update all internal links across README.md, OVERVIEW.md, DEVELOPMENT.md, CONTRIBUTING.md, RELEASING.md, copilot-instructions.md, and demo files. This follows CNCF best practices for documentation organization, making it easier for users to find relevant docs based on their role. Signed-off-by: Mark Chmarny <mchmarny@nvidia.com>
1 parent 921d865 commit c59faed

39 files changed

+80
-338
lines changed

.github/copilot-instructions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ NVIDIA Eidos provides validated GPU-accelerated Kubernetes configurations throug
124124
make test
125125
```
126126

127-
→ See [Bundler Development Guide](docs/architecture/component.md) for full details
127+
→ See [Bundler Development Guide](docs/contributor/component.md) for full details
128128

129129
### I Need To: Add New API Endpoint
130130

@@ -327,9 +327,9 @@ eidos bundle -r recipe.yaml -b gpu-operator,network-operator \
327327
- **[Contributing Guide](../CONTRIBUTING.md)** – Design principles, development setup, PR process
328328
- **[Development Guide](../DEVELOPMENT.md)** – Local development, Make targets, Tilt/Kind setup
329329
- **[Release Process](../RELEASING.md)** – Maintainer guide for releases, verification, hotfixes
330-
- **[Architecture Overview](../docs/architecture/README.md)** – System design
331-
- **[Bundler Development](../docs/architecture/component.md)** – Create new bundlers
332-
- **[API Reference](../docs/integration/api-reference.md)** – REST API endpoints
330+
- **[Architecture Overview](../docs/contributor/README.md)** – System design
331+
- **[Bundler Development](../docs/contributor/component.md)** – Create new bundlers
332+
- **[API Reference](../docs/integrator/api-reference.md)** – REST API endpoints
333333
- **[GitHub Actions README](actions/README.md)** – CI/CD architecture
334334
- **[API Specification](../api/eidos/v1/server.yaml)** – OpenAPI spec
335335
- **[.versions.yaml](../.versions.yaml)** – Tool versions (single source of truth)

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,6 @@ Signed-off-by: Your Name <your@email.com>
297297
- [DEVELOPMENT.md](DEVELOPMENT.md) - Development setup, architecture, and tooling
298298
- [README.md](README.md) - Project overview and quick start
299299
- [docs/OVERVIEW.md](docs/OVERVIEW.md) - System overview and glossary
300-
- [docs/architecture/README.md](docs/architecture/README.md) - Architecture documentation
300+
- [docs/contributor/README.md](docs/contributor/README.md) - Architecture documentation
301301

302302
Thank you for contributing to NVIDIA Eidos! Your efforts help improve GPU-accelerated infrastructure for everyone.

DEVELOPMENT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ eidos/
261261

262262
Business logic lives in `pkg/*` packages. The `pkg/cli` and `pkg/api` packages handle user interaction only, delegating to functional packages so both CLI and API can share the same logic.
263263

264-
For detailed architecture documentation, see [docs/architecture/README.md](docs/architecture/README.md).
264+
For detailed architecture documentation, see [docs/contributor/README.md](docs/contributor/README.md).
265265

266266
## Development Workflow
267267

@@ -651,10 +651,10 @@ make dev-reset
651651
## Additional Resources
652652

653653
### Project Documentation
654-
- [Architecture Overview](docs/architecture/README.md) - System design and components
655-
- [CLI Architecture](docs/architecture/cli.md) - CLI command structure
656-
- [Data Architecture](docs/architecture/data.md) - Recipe data model
657-
- [Bundler Development](docs/architecture/component.md) - Creating new bundlers
654+
- [Architecture Overview](docs/contributor/README.md) - System design and components
655+
- [CLI Architecture](docs/contributor/cli.md) - CLI command structure
656+
- [Data Architecture](docs/contributor/data.md) - Recipe data model
657+
- [Bundler Development](docs/contributor/component.md) - Creating new bundlers
658658

659659
### External Resources
660660
- [Go Documentation](https://golang.org/doc/)

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,8 @@ cleanup: ## Cleans up Eidos Kubernetes resources (requires kubectl)
232232
.PHONY: demos
233233
demos: ## Creates demo GIFs using VHS tool (requires: brew install vhs)
234234
@command -v vhs >/dev/null 2>&1 || (echo "Error: vhs is not installed. Install: brew install vhs" && exit 1)
235-
vhs docs/demos/videos/cli.tape -o docs/demos/videos/cli.gif
236-
vhs docs/demos/videos/e2e.tape -o docs/demos/videos/e2e.gif
235+
vhs examples/demos/videos/cli.tape -o examples/demos/videos/cli.gif
236+
vhs examples/demos/videos/e2e.tape -o examples/demos/videos/e2e.gif
237237

238238
# =============================================================================
239239
# Tilt Local Development

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ curl -sfL -H "Authorization: token $GITHUB_TOKEN" \
5555
https://raw.githubusercontent.com/NVIDIA/eidos/main/install | bash -s --
5656
```
5757

58-
See [Installation Guide](docs/user-guide/installation.md) for manual installation, building from source, and container images.
58+
See [Installation Guide](docs/user/installation.md) for manual installation, building from source, and container images.
5959

6060
### Quick Start
6161

@@ -79,43 +79,45 @@ eidos recipe --service eks --accelerator gb200 --os ubuntu --intent training --p
7979
eidos bundle --recipe recipe.yaml -o ./bundles
8080
```
8181

82-
The generated `bundles/` directory contains a Helm umbrella chart ready to deploy or commit to your GitOps repository. See [CLI Reference](docs/user-guide/cli-reference.md) for more options.
82+
The generated `bundles/` directory contains a Helm umbrella chart ready to deploy or commit to your GitOps repository. See [CLI Reference](docs/user/cli-reference.md) for more options.
8383

8484
### Get Started by Use Case
8585

86-
These use cases reflect common ways teams interact with Eidos.
86+
Choose the documentation path that matches how you'll use Eidos.
8787

8888
<details>
89-
<summary><strong>Platform and Infrastructure Operators</strong></summary>
89+
<summary><strong>User</strong> – Platform and Infrastructure Operators</summary>
9090

91-
You are responsible for deploying and operating GPU-accelerated Kubernetes clusters.
92-
- **[Installation Guide](docs/user-guide/installation.md)** – Install the eidos CLI (automated script, manual, or build from source)
93-
- **[CLI Reference](docs/user-guide/cli-reference.md)** – Complete command reference with examples
94-
- **[API Reference](docs/user-guide/api-reference.md)** – Complete API reference with examples
95-
- **[Agent Deployment](docs/user-guide/agent-deployment.md)** – Deploy the Kubernetes agent to get automated configuration snapshots
91+
You deploy and operate GPU-accelerated Kubernetes clusters using validated configurations.
92+
93+
- **[Installation Guide](docs/user/installation.md)** – Install the eidos CLI (automated script, manual, or build from source)
94+
- **[CLI Reference](docs/user/cli-reference.md)** – Complete command reference with examples
95+
- **[API Reference](docs/user/api-reference.md)** – REST API quick start
96+
- **[Agent Deployment](docs/user/agent-deployment.md)** – Deploy the Kubernetes agent for automated snapshots
9697
</details>
9798

9899
<details>
99-
<summary><strong>Developers and Contributors</strong></summary>
100+
<summary><strong>Contributor</strong> – Developers and Maintainers</summary>
100101

101-
You are contributing code, extending functionality, or working on Eidos internals.
102+
You contribute code, extend functionality, or work on Eidos internals.
102103

103104
- **[Contributing Guide](CONTRIBUTING.md)** – Development setup, testing, and PR process
104105
- **[Development Guide](DEVELOPMENT.md)** – Local development, Make targets, and tooling
105-
- **[Architecture Overview](docs/architecture/README.md)** – System design and components
106-
- **[Bundler Development](docs/architecture/component.md)** – How to create new bundlers
107-
- **[Data Architecture](docs/architecture/data.md)** – Recipe data model and query matching
106+
- **[Architecture Overview](docs/contributor/README.md)** – System design and components
107+
- **[Bundler Development](docs/contributor/component.md)** – How to create new bundlers
108+
- **[Data Architecture](docs/contributor/data.md)** – Recipe data model and query matching
108109
</details>
109110

110111
<details>
111-
<summary><strong>Integrators and Automation Engineers</strong></summary>
112+
<summary><strong>Integrator</strong> – Automation and Platform Engineers</summary>
112113

113-
You are integrating Eidos into CI/CD pipelines, GitOps workflows, or a larger product or service.
114+
You integrate Eidos into CI/CD pipelines, GitOps workflows, or larger platforms.
114115

115-
- **[API Reference](docs/integration/api-reference.md)** – REST API endpoints and usage examples
116-
- **[Data Flow](docs/integration/data-flow.md)** – Understanding snapshots, recipes, and bundles
117-
- **[Automation Guide](docs/integration/automation.md)** – CI/CD integration patterns
118-
- **[Kubernetes Deployment](docs/integration/kubernetes-deployment.md)** – Self-hosted API server setup
116+
- **[API Reference](docs/integrator/api-reference.md)** – REST API endpoints and usage examples
117+
- **[Data Flow](docs/integrator/data-flow.md)** – Understanding snapshots, recipes, and bundles
118+
- **[Automation Guide](docs/integrator/automation.md)** – CI/CD integration patterns
119+
- **[Kubernetes Deployment](docs/integrator/kubernetes-deployment.md)** – Self-hosted API server setup
120+
- **[Recipe Development](docs/integrator/recipe-development.md)** – Adding and modifying recipe metadata
119121
</details>
120122

121123
## Project Structure

RELEASING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ curl http://localhost:8080/health
174174

175175
## Demo Cloud Run Deployment
176176

177-
> **Note**: This is a **demonstration deployment** for testing and development purposes only. It is not a production service. Users should self-host the `eidosd` API server in their own infrastructure for production use. See [API Server Documentation](docs/architecture/api-server.md) for deployment guidance.
177+
> **Note**: This is a **demonstration deployment** for testing and development purposes only. It is not a production service. Users should self-host the `eidosd` API server in their own infrastructure for production use. See [API Server Documentation](docs/contributor/api-server.md) for deployment guidance.
178178
179179
The `eidosd` API server demo is automatically deployed to Google Cloud Run on successful release:
180180

docs/OVERVIEW.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -102,42 +102,42 @@ Eidos prioritizes trust in the software supply chain.
102102

103103
## Documentation
104104

105-
### User Guide
105+
Documentation is organized by persona to help you find what you need quickly.
106106

107-
| Document | Description |
108-
|----------|-------------|
109-
| [Installation](user-guide/installation.md) | Installing the `eidos` CLI |
110-
| [CLI Reference](user-guide/cli-reference.md) | Complete CLI command reference with examples |
111-
| [API Reference](user-guide/api-reference.md) | Quick start for the REST API |
112-
| [Agent Deployment](user-guide/agent-deployment.md) | Running the snapshot agent as a Kubernetes Job |
107+
### User Documentation
113108

114-
### Architecture
109+
For platform operators deploying and operating GPU-accelerated Kubernetes clusters.
115110

116111
| Document | Description |
117112
|----------|-------------|
118-
| [Architecture Overview](architecture/README.md) | System design, patterns, and deployment topologies |
119-
| [CLI Architecture](architecture/cli.md) | Detailed CLI implementation and workflow diagrams |
120-
| [API Server Architecture](architecture/api-server.md) | HTTP server design, middleware, and endpoints |
121-
| [Data Architecture](architecture/data.md) | Recipe metadata system, criteria matching, and inheritance |
122-
| [Bundler Development](architecture/component.md) | Guide for creating new bundlers |
113+
| [Installation](user/installation.md) | Installing the `eidos` CLI |
114+
| [CLI Reference](user/cli-reference.md) | Complete CLI command reference with examples |
115+
| [API Reference](user/api-reference.md) | Quick start for the REST API |
116+
| [Agent Deployment](user/agent-deployment.md) | Running the snapshot agent as a Kubernetes Job |
123117

124-
### Integration
118+
### Contributor Documentation
119+
120+
For developers contributing code, extending functionality, or working on Eidos internals.
125121

126122
| Document | Description |
127123
|----------|-------------|
128-
| [API Reference](integration/api-reference.md) | Complete REST API specification with examples |
129-
| [Automation](integration/automation.md) | CI/CD integration patterns |
130-
| [Data Flow](integration/data-flow.md) | Understanding recipe data architecture |
131-
| [Kubernetes Deployment](integration/kubernetes-deployment.md) | Self-hosted API server deployment |
132-
| [Recipe Development](integration/recipe-development.md) | Adding and modifying recipe metadata |
124+
| [Architecture Overview](contributor/README.md) | System design, patterns, and deployment topologies |
125+
| [CLI Architecture](contributor/cli.md) | Detailed CLI implementation and workflow diagrams |
126+
| [API Server Architecture](contributor/api-server.md) | HTTP server design, middleware, and endpoints |
127+
| [Data Architecture](contributor/data.md) | Recipe metadata system, criteria matching, and inheritance |
128+
| [Bundler Development](contributor/component.md) | Guide for creating new bundlers |
129+
130+
### Integrator Documentation
133131

134-
### Demos
132+
For engineers integrating Eidos into CI/CD pipelines, GitOps workflows, or larger platforms.
135133

136134
| Document | Description |
137135
|----------|-------------|
138-
| [End-to-End Demo](demos/e2e.md) | Complete workflow demonstration (snapshot → recipe → bundle) |
139-
| [Data Architecture Demo](demos/data.md) | Recipe metadata system walkthrough |
140-
| [Supply Chain Security Demo](demos/s3c.md) | Verifying SLSA attestations and SBOMs |
136+
| [API Reference](integrator/api-reference.md) | Complete REST API specification with examples |
137+
| [Automation](integrator/automation.md) | CI/CD integration patterns |
138+
| [Data Flow](integrator/data-flow.md) | Understanding recipe data architecture |
139+
| [Kubernetes Deployment](integrator/kubernetes-deployment.md) | Self-hosted API server deployment |
140+
| [Recipe Development](integrator/recipe-development.md) | Adding and modifying recipe metadata |
141141

142142
## Quick Start
143143

@@ -150,7 +150,7 @@ curl -sfL -H "Authorization: token $GITHUB_TOKEN" \
150150
https://raw.githubusercontent.com/NVIDIA/eidos/main/install | bash -s --
151151
```
152152

153-
See [Installation Guide](docs/user-guide/installation.md) for manual installation, building from source, and container images.
153+
See [Installation Guide](user/installation.md) for manual installation, building from source, and container images.
154154

155155
### Generate Recipe
156156

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)