Update the API references (#210)

Removing deprecate/removed APIs. Also removing the workspace API which was being generated but not linked in the contents. Adding the image controller references to the contents. Signed-off-by: arewm <[email protected]>
konflux-ci · Oct 18, 2024 · e25fda3 · e25fda3
1 parent 9eb9c42
commit e25fda3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 47 deletions.
diff --git a/.github/workflows/generate-api-docs.yml b/.github/workflows/generate-api-docs.yml
@@ -26,18 +26,6 @@ jobs:
           path: crd-temp/application-api
           repository: redhat-appstudio/application-api
 
-      - name: Checkout SPI
-        uses: actions/checkout@v3
-        with:
-          repository: redhat-appstudio/service-provider-integration-operator
-          path: crd-temp/service-provider
-
-      - name: Checkout GitOps
-        uses: actions/checkout@v3
-        with:
-          repository: redhat-appstudio/managed-gitops
-          path: crd-temp/managed-gitops
-
       - name: Checkout Build Service API
         uses: actions/checkout@v3
         with:
@@ -56,24 +44,12 @@ jobs:
           path: crd-temp/release-service
           repository: redhat-appstudio/release-service
 
-      - name: Checkout JVM Build Service API
-        uses: actions/checkout@v3
-        with:
-          path: crd-temp/jvm-build-service
-          repository: redhat-appstudio/jvm-build-service
-
       - name: Checkout Enterprise Contract API
         uses: actions/checkout@v3
         with:
           path: crd-temp/enterprise-contract-controller
           repository: enterprise-contract/enterprise-contract-controller
 
-      - name: Checkout DevSandbox API
-        uses: actions/checkout@v3
-        with:
-          path: crd-temp/devsandbox-api
-          repository: codeready-toolchain/api
-
       - name: Checkout Internal Services API
         uses: actions/checkout@v3
         with:
@@ -93,39 +69,27 @@ jobs:
           name: 'crd-ref-docs'
           version: '0.0.8'
 
-      - name: Generate service provider API docs
-        run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/service-provider.md --renderer=markdown --source-path=crd-temp/service-provider/api/v1beta1
-
       - name: Generate application and environment API docs
         run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/application-environment-api.md --renderer=markdown --source-path=crd-temp/application-api/api/v1alpha1
 
-      - name: Generate GitOps service API docs
-        run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/gitops.md --renderer=markdown --source-path=crd-temp/managed-gitops/backend-shared/apis/managed-gitops/v1alpha1
-
       - name: Generate Build Service API docs
         run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/build-service.md --renderer=markdown --source-path=crd-temp/build-service/api/v1alpha1/
 
+      - name: Generate Image Controller API docs
+        run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/image-controller.md --renderer=markdown --source-path=crd-temp/image-controller/api/v1alpha1/
+
       - name: Generate Integration Service API docs
         run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/integration-service.md --renderer=markdown --source-path=crd-temp/integration-service/api/v1alpha1/
 
       - name: Generate Release Service API docs
         run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/release-service.md --renderer=markdown --source-path=crd-temp/release-service/api/v1alpha1/
 
-      - name: Generate JVM Build Service API docs
-        run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/jvm-build-service.md --renderer=markdown --source-path=crd-temp/jvm-build-service/pkg/apis/jvmbuildservice/v1alpha1/
-
       - name: Generate Enterprise Contract API docs
         run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/enterprise-contract.md --renderer=markdown --source-path=crd-temp/enterprise-contract-controller/api/v1alpha1/
 
-      - name: Generate devsandbox API docs
-        run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/devsandbox.md --renderer=markdown --source-path=crd-temp/devsandbox-api/api/v1alpha1
-
       - name: Generate Internal Services API docs
         run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/internal-services.md --renderer=markdown --source-path=crd-temp/internal-services/api/v1alpha1/
 
-      - name: Generate Image Controller API docs
-        run: crd-ref-docs --log-level=ERROR --config=ref/config.yaml --output-path=ref/image-controller.md --renderer=markdown --source-path=crd-temp/image-controller/api/v1alpha1/
-
       - name: Upload generated docs
         uses: actions/upload-artifact@v3
         with:

diff --git a/_config.yml b/_config.yml
@@ -12,17 +12,21 @@ navigation:
     sublist:
     - name: Application and Environment API
       link: /architecture/ref/application-environment-api.html
-    - name: Service Provider (SPI)
-      link: /architecture/ref/service-provider.html
-    - name: GitOps Service
-      link: /architecture/ref/gitops.html
+    # - name: Service Provider (SPI)
+    #   link: /architecture/ref/service-provider.html
+    # - name: GitOps Service
+    #   link: /architecture/ref/gitops.html
     - name: Build Service
       link: /architecture/ref/build-service.html
-    - name: JVM Build Service
-      link: /architecture/ref/jvm-build-service.html
+    - name: Image Controller
+      link: /architecture/ref/image-controller.html
+    # - name: JVM Build Service
+    #   link: /architecture/ref/jvm-build-service.html
     - name: Integration Service
       link: /architecture/ref/integration-service.html
-    - name: Release Service
-      link: /architecture/ref/release-service.html
     - name: Enterprise Contract
       link: /architecture/ref/enterprise-contract.html
+    - name: Release Service
+      link: /architecture/ref/release-service.html
+    - name: Internal Services
+      link: /architecture/ref/internal-services.html