update doc to get kserve value

opendatahub-io · Mar 8, 2024 · 52b6c9d · 52b6c9d
1 parent 3ad878b
commit 52b6c9d
Show file tree

Hide file tree

Showing 15 changed files with 409 additions and 5 deletions.
diff --git a/Makefile b/Makefile
@@ -163,9 +163,8 @@ CLEANFILES += odh-manifests/*
 
 .PHONY: api-docs
 api-docs: crd-ref-docs ## Creates API docs using https://github.com/elastic/crd-ref-docs
-	$(CRD_REF_DOCS) --source-path ./apis --output-path ./docs/api-overview.md --renderer markdown --config ./crd-ref-docs.config.yaml
-##@ Build
-
+	$(CRD_REF_DOCS) --source-path ./ --output-path ./docs/api-overview.md --renderer markdown --config ./crd-ref-docs.config.yaml && \
+	egrep -v '\.io/[^v][^1].*)$$' ./docs/api-overview.md > temp.md && mv ./temp.md ./docs/api-overview.md
 .PHONY: build
 build: generate fmt vet ## Build manager binary.
 	go build -o bin/manager main.go

diff --git a/apis/infrastructure/v1/groupversion_info.go b/apis/infrastructure/v1/groupversion_info.go
@@ -0,0 +1,2 @@
+// +groupName=datasciencecluster.opendatahub.io
+package v1
diff --git a/components/codeflare/codeflare.go b/components/codeflare/codeflare.go
@@ -1,5 +1,6 @@
 // Package codeflare provides utility functions to config CodeFlare as part of the stack
 // which makes managing distributed compute infrastructure in the cloud easy and intuitive for Data Scientists
+// +groupName=datasciencecluster.opendatahub.io
 package codeflare
 
 import (

diff --git a/components/component.go b/components/component.go
@@ -1,3 +1,4 @@
+// +groupName=datasciencecluster.opendatahub.io
 package components
 
 import (

diff --git a/components/dashboard/dashboard.go b/components/dashboard/dashboard.go
@@ -1,5 +1,6 @@
 // Package dashboard provides utility functions to config Open Data Hub Dashboard: A web dashboard that displays
 // installed Open Data Hub components with easy access to component UIs and documentation
+// +groupName=datasciencecluster.opendatahub.io
 package dashboard
 
 import (

diff --git a/components/datasciencepipelines/datasciencepipelines.go b/components/datasciencepipelines/datasciencepipelines.go
@@ -1,5 +1,6 @@
 // Package datasciencepipelines provides utility functions to config Data Science Pipelines:
 // Pipeline solution for end to end MLOps workflows that support the Kubeflow Pipelines SDK and Tekton
+// +groupName=datasciencecluster.opendatahub.io
 package datasciencepipelines
 
 import (

diff --git a/components/kserve/kserve.go b/components/kserve/kserve.go
@@ -1,4 +1,5 @@
 // Package kserve provides utility functions to config Kserve as the Controller for serving ML models on arbitrary frameworks
+// +groupName=datasciencecluster.opendatahub.io
 package kserve
 
 import (

diff --git a/components/kueue/kueue.go b/components/kueue/kueue.go
@@ -1,3 +1,4 @@
+// +groupName=datasciencecluster.opendatahub.io
 package kueue
 
 import (

diff --git a/components/modelmeshserving/modelmeshserving.go b/components/modelmeshserving/modelmeshserving.go
@@ -1,4 +1,5 @@
 // Package modelmeshserving provides utility functions to config MoModelMesh, a general-purpose model serving management/routing layer
+// +groupName=datasciencecluster.opendatahub.io
 package modelmeshserving
 
 import (

diff --git a/components/modelregistry/modelregistry.go b/components/modelregistry/modelregistry.go
@@ -1,4 +1,5 @@
 // Package modelregistry provides utility functions to config ModelRegistry, an ML Model metadata repository service
+// +groupName=datasciencecluster.opendatahub.io
 package modelregistry
 
 import (

diff --git a/components/ray/ray.go b/components/ray/ray.go
@@ -1,5 +1,6 @@
 // Package ray provides utility functions to config Ray as part of the stack
 // which makes managing distributed compute infrastructure in the cloud easy and intuitive for Data Scientists
+// +groupName=datasciencecluster.opendatahub.io
 package ray
 
 import (

diff --git a/components/trustyai/trustyai.go b/components/trustyai/trustyai.go
@@ -1,4 +1,5 @@
 // Package trustyai provides utility functions to config TrustyAI, a bias/fairness and explainability toolkit
+// +groupName=datasciencecluster.opendatahub.io
 package trustyai
 
 import (

diff --git a/components/workbenches/workbenches.go b/components/workbenches/workbenches.go
@@ -1,4 +1,5 @@
 // Package workbenches provides utility functions to config Workbenches to secure Jupyter Notebook in Kubernetes environments with support for OAuth
+// +groupName=datasciencecluster.opendatahub.io
 package workbenches
 
 import (

diff --git a/config/crd/bases/datasciencecluster.opendatahub.io_datascienceclusters.yaml b/config/crd/bases/datasciencecluster.opendatahub.io_datascienceclusters.yaml
@@ -184,7 +184,8 @@ spec:
                           This can be set to 'Serverless' or 'RawDeployment'. The
                           value specified in this field will be used to set the default
                           deployment mode in the 'inferenceservice-config' configmap
-                          for Kserve
+                          for Kserve If no default deployment mode is specified, Kserve
+                          will use Serverless mode
                         enum:
                         - Serverless
                         - RawDeployment
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// +groupName=datasciencecluster.opendatahub.io
		package v1