Unverified Commit ece08dc9 authored by Neal Vaidya's avatar Neal Vaidya Committed by GitHub
Browse files

docs: restructure docs directory and move fern config to fern/ (#6700)


Signed-off-by: default avatarNeal Vaidya <nealv@nvidia.com>
Co-authored-by: default avatarClaude Opus 4.6 <noreply@anthropic.com>
parent 1412e44b
...@@ -305,7 +305,7 @@ def create_kv_events_config( ...@@ -305,7 +305,7 @@ def create_kv_events_config(
"(matching upstream vLLM). To preserve current behavior, pass " "(matching upstream vLLM). To preserve current behavior, pass "
"--kv-events-config explicitly. For example:\n" "--kv-events-config explicitly. For example:\n"
f' --kv-events-config \'{{"enable_kv_cache_events":true,"publisher":"zmq","endpoint":"tcp://*:{port}"}}\'\n' f' --kv-events-config \'{{"enable_kv_cache_events":true,"publisher":"zmq","endpoint":"tcp://*:{port}"}}\'\n'
"See docs/pages/backends/vllm/README.md for details.", "See docs/backends/vllm/README.md for details.",
FutureWarning, FutureWarning,
stacklevel=2, stacklevel=2,
) )
......
...@@ -5,4 +5,4 @@ SPDX-License-Identifier: Apache-2.0 ...@@ -5,4 +5,4 @@ SPDX-License-Identifier: Apache-2.0
# Dynamo Service Discovery # Dynamo Service Discovery
For documentation on Dynamo's service discovery system, see the [Service Discovery Guide](../../docs/pages/kubernetes/service-discovery.md). For documentation on Dynamo's service discovery system, see the [Service Discovery Guide](../../docs/kubernetes/service-discovery.md).
...@@ -166,8 +166,8 @@ Ensure your storage class supports `ReadWriteMany` access mode for multi-node de ...@@ -166,8 +166,8 @@ Ensure your storage class supports `ReadWriteMany` access mode for multi-node de
## Related Documentation ## Related Documentation
- [ChReK Overview](../../../../docs/pages/kubernetes/chrek/README.md) - ChReK architecture and use cases - [ChReK Overview](../../../../docs/kubernetes/chrek/README.md) - ChReK architecture and use cases
- [ChReK with Dynamo Platform](../../../../docs/pages/kubernetes/chrek/dynamo.md) - Integration guide - [ChReK with Dynamo Platform](../../../../docs/kubernetes/chrek/dynamo.md) - Integration guide
## License ## License
......
...@@ -208,7 +208,7 @@ For detailed etcd configuration options, please refer to the official Bitnami et ...@@ -208,7 +208,7 @@ For detailed etcd configuration options, please refer to the official Bitnami et
## 📚 Additional Resources ## 📚 Additional Resources
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/pages/kubernetes/installation-guide.md) - [Dynamo Cloud Deployment Installation Guide](../../../../docs/kubernetes/installation-guide.md)
- [NATS Documentation](https://docs.nats.io/) - [NATS Documentation](https://docs.nats.io/)
- [etcd Documentation](https://etcd.io/docs/) - [etcd Documentation](https://etcd.io/docs/)
- [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) - [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
......
...@@ -127,7 +127,7 @@ For detailed etcd configuration options, please refer to the official Bitnami et ...@@ -127,7 +127,7 @@ For detailed etcd configuration options, please refer to the official Bitnami et
## 📚 Additional Resources ## 📚 Additional Resources
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/pages/kubernetes/installation-guide.md) - [Dynamo Cloud Deployment Installation Guide](../../../../docs/kubernetes/installation-guide.md)
- [NATS Documentation](https://docs.nats.io/) - [NATS Documentation](https://docs.nats.io/)
- [etcd Documentation](https://etcd.io/docs/) - [etcd Documentation](https://etcd.io/docs/)
- [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) - [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
......
...@@ -71,7 +71,7 @@ spec: ...@@ -71,7 +71,7 @@ spec:
autoscaling: autoscaling:
description: |- description: |-
Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter
with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md
for migration guidance. This field will be removed in a future API version. for migration guidance. This field will be removed in a future API version.
properties: properties:
behavior: behavior:
......
...@@ -287,7 +287,7 @@ spec: ...@@ -287,7 +287,7 @@ spec:
autoscaling: autoscaling:
description: |- description: |-
Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter
with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md
for migration guidance. This field will be removed in a future API version. for migration guidance. This field will be removed in a future API version.
properties: properties:
behavior: behavior:
......
...@@ -5,4 +5,4 @@ SPDX-License-Identifier: Apache-2.0 --> ...@@ -5,4 +5,4 @@ SPDX-License-Identifier: Apache-2.0 -->
Integrate Dynamo with the Gateway API Inference Extension for intelligent KV-aware request routing at the gateway layer. Integrate Dynamo with the Gateway API Inference Extension for intelligent KV-aware request routing at the gateway layer.
See [Inference Gateway documentation](../../docs/pages/kubernetes/inference-gateway.md) for full setup instructions, configuration options, and deployment examples. See [Inference Gateway documentation](../../docs/kubernetes/inference-gateway.md) for full setup instructions, configuration options, and deployment examples.
# Dynamo Observability # Dynamo Observability
For detailed documentation on Observability (Prometheus metrics, tracing, and logging), please refer to [docs/pages/observability/](../../docs/pages/observability/). For detailed documentation on Observability (Prometheus metrics, tracing, and logging), please refer to [docs/observability/](../../docs/observability/).
...@@ -10,6 +10,6 @@ This directory contains example Grafana dashboards for Dynamo observability. The ...@@ -10,6 +10,6 @@ This directory contains example Grafana dashboards for Dynamo observability. The
- `temp-loki.json` - Logging dashboard for Loki integration - `temp-loki.json` - Logging dashboard for Loki integration
- `dashboard-providers.yml` - Configuration file for dashboard provisioning - `dashboard-providers.yml` - Configuration file for dashboard provisioning
For setup instructions and usage, see [Observability Documentation](../../../docs/pages/observability/). For setup instructions and usage, see [Observability Documentation](../../../docs/observability/).
For Kubernetes deployment setup, see [../k8s/MONITORING_SETUP.md](../k8s/MONITORING_SETUP.md). For Kubernetes deployment setup, see [../k8s/MONITORING_SETUP.md](../k8s/MONITORING_SETUP.md).
# Dynamo Metrics Collection on Kubernetes # Dynamo Metrics Collection on Kubernetes
For detailed documentation on collecting and visualizing metrics on Kubernetes, see [docs/pages/kubernetes/observability/metrics.md](../../../docs/pages/kubernetes/observability/metrics.md). For detailed documentation on collecting and visualizing metrics on Kubernetes, see [docs/kubernetes/observability/metrics.md](../../../docs/kubernetes/observability/metrics.md).
# Dynamo Logging on Kubernetes # Dynamo Logging on Kubernetes
For detailed documentation on collecting and visualizing logs on Kubernetes, see [docs/pages/kubernetes/observability/logging.md](../../../../docs/pages/kubernetes/observability/logging.md). For detailed documentation on collecting and visualizing logs on Kubernetes, see [docs/kubernetes/observability/logging.md](../../../../docs/kubernetes/observability/logging.md).
...@@ -314,12 +314,12 @@ generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRD ...@@ -314,12 +314,12 @@ generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRD
--output-path=./docs/api_reference.md --output-path=./docs/api_reference.md
@echo "✅ Generated API reference at ./docs/api_reference.md" @echo "✅ Generated API reference at ./docs/api_reference.md"
# concatenate header.md, api_reference.md, and footer.md # concatenate header.md, api_reference.md, and footer.md
cat docs/header.md ./docs/api_reference.md docs/footer.md > ../../docs/pages/kubernetes/api-reference.md cat docs/header.md ./docs/api_reference.md docs/footer.md > ../../docs/kubernetes/api-reference.md
rm ./docs/api_reference.md rm ./docs/api_reference.md
@echo "✅ Concatenated header.md, api_reference.md, and footer.md" @echo "✅ Concatenated header.md, api_reference.md, and footer.md"
# Fix duplicate anchors: crd-ref-docs generates identical anchors for same-named types # Fix duplicate anchors: crd-ref-docs generates identical anchors for same-named types
# across API versions; prepend "v1beta1 " to affected v1beta1 headings and links. # across API versions; prepend "v1beta1 " to affected v1beta1 headings and links.
python3 docs/fix-api-anchors.py ../../docs/pages/kubernetes/api-reference.md python3 docs/fix-api-anchors.py ../../docs/kubernetes/api-reference.md
HELM_CHART_DIR := ../helm/charts/platform HELM_CHART_DIR := ../helm/charts/platform
......
...@@ -33,4 +33,4 @@ make ...@@ -33,4 +33,4 @@ make
### Install ### Install
See [Dynamo Kubernetes Platform Installation Guide](/docs/pages/kubernetes/installation-guide.md) for installation instructions. See [Dynamo Kubernetes Platform Installation Guide](/docs/kubernetes/installation-guide.md) for installation instructions.
...@@ -56,7 +56,7 @@ type VolumeMount struct { ...@@ -56,7 +56,7 @@ type VolumeMount struct {
} }
// Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter // Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter
// with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md // with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md
// for migration guidance. This field will be removed in a future API version. // for migration guidance. This field will be removed in a future API version.
type Autoscaling struct { type Autoscaling struct {
// Deprecated: This field is ignored. // Deprecated: This field is ignored.
......
...@@ -78,7 +78,7 @@ type DynamoComponentDeploymentSharedSpec struct { ...@@ -78,7 +78,7 @@ type DynamoComponentDeploymentSharedSpec struct {
// GPUs/devices, and any runtime-specific resources. // GPUs/devices, and any runtime-specific resources.
Resources *Resources `json:"resources,omitempty"` Resources *Resources `json:"resources,omitempty"`
// Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter // Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter
// with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md // with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md
// for migration guidance. This field will be removed in a future API version. // for migration guidance. This field will be removed in a future API version.
Autoscaling *Autoscaling `json:"autoscaling,omitempty"` Autoscaling *Autoscaling `json:"autoscaling,omitempty"`
// Envs defines additional environment variables to inject into the component containers. // Envs defines additional environment variables to inject into the component containers.
......
...@@ -71,7 +71,7 @@ spec: ...@@ -71,7 +71,7 @@ spec:
autoscaling: autoscaling:
description: |- description: |-
Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter
with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md
for migration guidance. This field will be removed in a future API version. for migration guidance. This field will be removed in a future API version.
properties: properties:
behavior: behavior:
......
...@@ -287,7 +287,7 @@ spec: ...@@ -287,7 +287,7 @@ spec:
autoscaling: autoscaling:
description: |- description: |-
Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter Deprecated: This field is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter
with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md
for migration guidance. This field will be removed in a future API version. for migration guidance. This field will be removed in a future API version.
properties: properties:
behavior: behavior:
......
...@@ -109,7 +109,7 @@ func (v *SharedSpecValidator) Validate(ctx context.Context) (admission.Warnings, ...@@ -109,7 +109,7 @@ func (v *SharedSpecValidator) Validate(ctx context.Context) (admission.Warnings,
if v.spec.Autoscaling != nil { if v.spec.Autoscaling != nil {
warnings = append(warnings, fmt.Sprintf( warnings = append(warnings, fmt.Sprintf(
"%s.autoscaling is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter "+ "%s.autoscaling is deprecated and ignored. Use DynamoGraphDeploymentScalingAdapter "+
"with HPA, KEDA, or Planner for autoscaling instead. See docs/pages/kubernetes/autoscaling.md", "with HPA, KEDA, or Planner for autoscaling instead. See docs/kubernetes/autoscaling.md",
v.fieldPath)) v.fieldPath))
} }
......
...@@ -6,7 +6,7 @@ This directory contains utilities and manifests for Dynamo benchmarking and prof ...@@ -6,7 +6,7 @@ This directory contains utilities and manifests for Dynamo benchmarking and prof
**Before using these utilities, you must first set up Dynamo Kubernetes Platform following the main installation guide:** **Before using these utilities, you must first set up Dynamo Kubernetes Platform following the main installation guide:**
👉 **[Follow the Dynamo Kubernetes Platform installation guide](/docs/pages/kubernetes/installation-guide.md) to install the Dynamo Kubernetes Platform first.** 👉 **[Follow the Dynamo Kubernetes Platform installation guide](/docs/kubernetes/installation-guide.md) to install the Dynamo Kubernetes Platform first.**
This includes: This includes:
1. Installing the Dynamo CRDs 1. Installing the Dynamo CRDs
...@@ -144,8 +144,8 @@ kubectl delete pod pvc-access-pod -n $NAMESPACE ...@@ -144,8 +144,8 @@ kubectl delete pod pvc-access-pod -n $NAMESPACE
#### Next Steps #### Next Steps
For complete benchmarking and profiling workflows: For complete benchmarking and profiling workflows:
- **Benchmarking Guide**: See [docs/pages/benchmarks/benchmarking.md](../../docs/pages/benchmarks/benchmarking.md) for comparing DynamoGraphDeployments and external endpoints - **Benchmarking Guide**: See [docs/benchmarks/benchmarking.md](../../docs/benchmarks/benchmarking.md) for comparing DynamoGraphDeployments and external endpoints
- **Pre-Deployment Profiling**: See [docs/pages/components/profiler/profiler-guide.md](../../docs/pages/components/profiler/profiler-guide.md) for optimizing configurations before deployment - **Pre-Deployment Profiling**: See [docs/components/profiler/profiler-guide.md](../../docs/components/profiler/profiler-guide.md) for optimizing configurations before deployment
## Notes ## Notes
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment