Skip to content

Commit 94ba274

Browse files
committed
docs: clean up public launch documentation
1 parent eea3b3a commit 94ba274

30 files changed

+290
-278
lines changed

.github/actions/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,13 @@ This action runs `tools/setup-tools --skip-go --skip-docker` in auto mode, which
196196
```yaml
197197
- uses: ./.github/actions/cloud-run-deploy
198198
with:
199-
project_id: 'eidosx'
199+
project_id: 'example-gcp-project'
200200
workload_identity_provider: 'projects/.../providers/github-actions-provider'
201-
service_account: 'github-actions@eidosx.iam.gserviceaccount.com'
201+
service_account: 'github-actions@example-gcp-project.iam.gserviceaccount.com'
202202
region: 'us-west1'
203203
service: 'api'
204204
source_image: 'ghcr.io/nvidia/aicrd:v1.0.0'
205-
target_registry: 'us-docker.pkg.dev/eidosx/demo'
205+
target_registry: 'us-docker.pkg.dev/example-gcp-project/demo'
206206
image_name: 'aicrd'
207207
ghcr_token: ${{ github.token }}
208208
```

.github/copilot-instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func (r *Reader) Read(url string) ([]byte, error) {
5353
**Git Configuration:**
5454
- Commit to `main` branch (not `master`)
5555
- Do NOT add `Co-Authored-By` lines (organization policy)
56-
- Use DCO sign-off: `git commit -s -m "message"`
56+
- Use cryptographic commit signing: `git commit -S -m "message"` (use `-s` only when DCO sign-off is required for non-member contributions)
5757

5858
**Decision Framework:**
5959
Choose solutions based on: testability, readability, consistency, simplicity, reversibility
@@ -178,7 +178,7 @@ NVIDIA AICR provides validated GPU-accelerated Kubernetes configurations through
178178
make test
179179
```
180180

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

183183
### I Need To: Add New API Endpoint
184184

@@ -800,7 +800,7 @@ jobs:
800800
- uses: ./.github/actions/cloud-run-deploy
801801
with:
802802
source_image: 'ghcr.io/nvidia/aicrd:${{ github.ref_name }}'
803-
target_registry: 'us-docker.pkg.dev/eidosx/demo'
803+
target_registry: 'us-docker.pkg.dev/example-gcp-project/demo'
804804
```
805805
806806
**Supply Chain Security:**

CONTRIBUTING.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -150,18 +150,22 @@ Trust is established through evidence, not assertions. Every released artifact c
150150
- DEVELOPMENT.md for developer workflow changes
151151
- Code comments and godoc for API changes
152152

153-
3. **Commit with DCO sign-off:**
153+
3. **Commit with required provenance:**
154154
```bash
155+
# External contributors (DCO sign-off required)
155156
git commit -s -m "feat: add network collector
156157
157158
- Implement NetworkCollector interface
158159
- Add unit tests with 80% coverage
159160
- Update factory registration
160161
161162
Fixes #123"
163+
164+
# NVIDIA org members / automation (DCO sign-off exempt)
165+
git commit -S -m "feat: add network collector"
162166
```
163167

164-
**Important**: Always use `-s` flag for DCO sign-off.
168+
External contributors must use `-s`. NVIDIA organization members are exempt from DCO bot sign-off checks and should use cryptographic signing (`-S`).
165169

166170
### Creating the Pull Request
167171

@@ -178,7 +182,7 @@ Trust is established through evidence, not assertions. Every released artifact c
178182
- Go tests with race detector
179183
- golangci-lint
180184
- YAML linting
181-
- Security scan (Trivy)
185+
- Security scans (Trivy in CI, Grype in `make scan`)
182186
- Coverage tracking
183187
- E2E tests
184188

@@ -190,7 +194,9 @@ Trust is established through evidence, not assertions. Every released artifact c
190194

191195
3. **Address Feedback** by pushing new commits:
192196
```bash
193-
git commit -s -m "address review: improve error handling"
197+
git commit -s -m "address review: improve error handling" # external contributors
198+
# or
199+
git commit -S -m "address review: improve error handling" # NVIDIA org members / automation
194200
git push origin your-branch
195201
```
196202

@@ -226,9 +232,9 @@ git push origin --delete your-branch
226232

227233
## Developer Certificate of Origin
228234

229-
All contributions must include a DCO sign-off to certify that you have the right to submit the contribution under the project's license.
235+
Contributions must satisfy Developer Certificate of Origin (DCO) policy. External contributors (non-NVIDIA organization members) must include a DCO sign-off on each commit. NVIDIA organization members are exempt from DCO bot sign-off checks and should use cryptographic signing (`-S`).
230236

231-
### How to Sign Off
237+
### How to Sign Off (External Contributors)
232238

233239
Add the `-s` flag to your commit:
234240

@@ -258,6 +264,14 @@ git commit --amend --signoff
258264
git push --force-with-lease origin your-branch
259265
```
260266

267+
### NVIDIA Org Members and Automation
268+
269+
NVIDIA organization members are exempt from DCO bot sign-off checks (`.github/dco.yml`). Use cryptographic commit signing:
270+
271+
```bash
272+
git commit -S -m "Your commit message"
273+
```
274+
261275
### What You're Certifying
262276

263277
By signing off, you certify the Developer Certificate of Origin 1.1:

DEVELOPMENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -801,7 +801,7 @@ make validate-local RECIPE=recipe.yaml IMAGE_TAG=dev
801801

802802
For detailed information on adding validation checks and constraint validators, see:
803803

804-
**[pkg/validator/checks/README.md](../pkg/validator/checks/README.md)**
804+
**[pkg/validator/checks/README.md](pkg/validator/checks/README.md)**
805805

806806
This comprehensive guide covers:
807807
- Architecture overview (Job-based validation, test registration framework)

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ This separation allows the same validated configuration to be applied consistent
4848

4949
Install the latest version using the installation script:
5050

51-
> Note: Temporally, while the repo is private, make sure to include your GitHub token first:
52-
5351
```shell
5452
curl -sfL https://raw.githubusercontent.com/NVIDIA/aicr/main/install | bash -s --
5553
```
@@ -122,7 +120,7 @@ You integrate AICR into CI/CD pipelines, GitOps workflows, or larger platforms.
122120

123121
## Documentation & Resources
124122

125-
- **[Documentation](/docs)** – Documentation, guides, and examples.
123+
- **[Documentation](docs/README.md)** – Documentation, guides, and examples.
126124
- **[Roadmap](ROADMAP.md)** – Feature priorities and development timeline
127125
- **[Overview](docs/README.md)** - Detailed system overview and glossary
128126
- **[Security](SECURITY.md)** - Security-related resources
@@ -131,4 +129,4 @@ You integrate AICR into CI/CD pipelines, GitOps workflows, or larger platforms.
131129

132130
## Contributing
133131

134-
Contributions are welcome. See [contributing](/CONTRIBUTING.md) for development setup, contribution guidelines, and the pull request process.
132+
Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, contribution guidelines, and the pull request process.

RELEASING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Every release must pass these automated gates before artifacts are published:
2929
- Unit tests with race detector
3030
- golangci-lint + yamllint
3131
- License header verification
32-
- Trivy vulnerability scan
32+
- Vulnerability scans (Trivy in release workflows, Grype in `make scan`)
3333
- E2E tests on Kind cluster
3434

3535
If any gate fails, the release pipeline stops. Fix forward on `main` and cut a new tag.
@@ -148,7 +148,7 @@ sha256sum -c checksums.txt --ignore-missing
148148

149149
> **Note**: Demonstration only — not a production service. Self-host `aicrd` for production use. See [API Server Documentation](docs/contributor/api-server.md).
150150
151-
The `aicrd` API server demo deploys to Google Cloud Run on successful release (project: `eidosx`, region: `us-west1`, auth: Workload Identity Federation).
151+
The `aicrd` API server demo deploys to Google Cloud Run on successful release (region: `us-west1`, auth: Workload Identity Federation). Project-specific details are managed in CI configuration.
152152

153153
## Troubleshooting
154154

docs/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ AICR prioritizes trust in the software supply chain.
104104

105105
- `api/` — OpenAPI specifications for the REST API
106106
- `cmd/` — Entry points for CLI (`aicr`) and API server (`aicrd`)
107-
- `deployments/`Kubernetes manifests for agent deployment
107+
- `recipes/`Recipe overlays, component values, and validation checks
108108
- `docs/` — User-facing documentation, guides, and architecture docs
109109
- `examples/` — Example snapshots, recipes, and comparisons
110110
- `infra/` — Infrastructure as code (Terraform) for deployments
@@ -154,11 +154,8 @@ For engineers integrating AICR into CI/CD pipelines, GitOps workflows, or larger
154154

155155
### Install CLI
156156

157-
> Note: Temporally, while the repo is private, make sure to include your GitHub token first:
158-
159157
```shell
160-
curl -sfL -H "Authorization: token $GITHUB_TOKEN" \
161-
https://raw.githubusercontent.com/NVIDIA/aicr/main/install | bash -s --
158+
curl -sfL https://raw.githubusercontent.com/NVIDIA/aicr/main/install | bash -s --
162159
```
163160

164161
See [Installation Guide](user/installation.md) for manual installation, building from source, and container images.

0 commit comments

Comments
 (0)