Skip to content

Commit c072894

Browse files
committed
Add comprehensive vLLM and Ollama distribution documentation
- Created detailed vLLM distribution guide with GPU/CPU variants, configuration examples, and best practices - Created comprehensive Ollama distribution guide with model management, API usage, and troubleshooting - Added new 'Distributions' section to navigation with dedicated pages for each distribution type - Includes production and development examples, resource planning, and scaling strategies - Clearly distinguishes supported distributions from BYO (bring-your-own) custom image approaches Signed-off-by: Adel Zaalouk <[email protected]>
1 parent fdafb84 commit c072894

34 files changed

+4169
-42
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@ jobs:
107107
directory: docs/site
108108
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
109109
wranglerVersion: '3'
110-
continue-on-error: true
111110

112111
deploy-production:
113112
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
@@ -132,7 +131,6 @@ jobs:
132131
directory: docs/site
133132
gitHubToken: ${{ secrets.GITHUB_TOKEN }}
134133
wranglerVersion: '3'
135-
continue-on-error: true
136134

137135
- name: Update legacy API docs (backward compatibility)
138136
run: |
@@ -195,4 +193,4 @@ jobs:
195193
uses: github/codeql-action/upload-sarif@v3
196194
if: always()
197195
with:
198-
sarif_file: 'trivy-results.sarif'
196+
sarif_file: 'trivy-results.sarif'

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ docs/
6565

6666
### Prerequisites
6767

68-
- **Go 1.21+** - For API documentation generation tools
68+
- **Go 1.24+** - For API documentation generation tools
6969
- **Python 3.8+** - For MkDocs and dependencies
7070
- **pip3** - Python package manager
7171

@@ -318,4 +318,4 @@ cd docs && mkdocs serve --dev-addr 0.0.0.0:8001
318318

319319
## 📄 License
320320

321-
This documentation is licensed under the Apache License 2.0. See the [LICENSE](../LICENSE) file for details.
321+
This documentation is licensed under the Apache License 2.0. See the [LICENSE](../LICENSE) file for details.

docs/api-doc-gen/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@
2727
"github.com/llamastack/llama-stack-k8s-operator/api/v1alpha1": ""
2828
},
2929
"markdownDisabled": false
30-
}
30+
}

docs/content/contributing/development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Guide for contributing to the LlamaStack Kubernetes Operator.
66

77
### Prerequisites
88

9-
- Go 1.21+
9+
- Go 1.24+
1010
- Docker
1111
- Kubernetes cluster (kind/minikube for local development)
1212
- kubectl
@@ -53,4 +53,4 @@ make run
5353
## Next Steps
5454

5555
- [Testing Guide](testing.md)
56-
- [Documentation Guide](documentation.md)
56+
- [Documentation Guide](documentation.md)

docs/content/contributing/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ make api-docs
7272
## Next Steps
7373

7474
- [Development Guide](development.md)
75-
- [Testing Guide](testing.md)
75+
- [Testing Guide](testing.md)

docs/content/contributing/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ func TestE2EDeployment(t *testing.T) {
4848
## Next Steps
4949

5050
- [Development Guide](development.md)
51-
- [Documentation Guide](documentation.md)
51+
- [Documentation Guide](documentation.md)

0 commit comments

Comments
 (0)