Merge pull request Mellanox#114 from souleb/attempt-fix-api-docs

Attempt to fix api-docs generation
nvidia-ci-cd · Oct 11, 2024 · a1faa5a · a1faa5a
2 parents 7b716be + bbbfb02
commit a1faa5a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/.github/workflows/docs-ci.yaml b/.github/workflows/docs-ci.yaml
@@ -26,9 +26,13 @@ jobs:
       with:
         repository: ${{ github.repository_owner }}/network-operator-docs  # repo must be explicitly set here for workflow calling to behave correctly
         token: ${{ inputs.token || secrets.GH_TOKEN_NVIDIA_CI_CD }}  # token must be explicitly set here for push to work in following step
+    - name: Setup Go
+      uses: actions/[email protected]
+      with:
+        go-version: 1.23.x
     - name: Make docs
       run: |
-        make helm-docs generate-docs-versions-var api-docs
+        make api-docs helm-docs generate-docs-versions-var
     - name: Close any existing documentation PRs
       run: |
         for pr_number in $(gh pr list --search "$PR_TITLE_PREFIX" --json number --jq ".[].number"); do

diff --git a/docs/customizations/crds.rst b/docs/customizations/crds.rst
@@ -657,13 +657,13 @@ NicClusterPolicySpec defines the desired state of NicClusterPolicy
       | ``secondaryNetwork``                                                                              | Configuration options for secondary network                                                       |
       | :ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>`                                                |                                                                                                   |
       +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
-      | ``nvIpam``                                                                                        | Configuration options nv-ipam                                                                     |
+      | ``nvIpam``                                                                                        | Configuration options for nv-ipam                                                                 |
       | :ref:`NVIPAMSpec <NVIPAMSpec>`                                                                    |                                                                                                   |
       +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
-      | ``nicFeatureDiscovery``                                                                           | Configuration options nic-feature-discovery                                                       |
+      | ``nicFeatureDiscovery``                                                                           | Configuration options for nic-feature-discovery                                                   |
       | :ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>`                                          |                                                                                                   |
       +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
-      | ``docaTelemetryService``                                                                          | Configuration options DOCA Telemetry Service                                                      |
+      | ``docaTelemetryService``                                                                          | Configuration options for DOCA Telemetry Service                                                  |
       | :ref:`DOCATelemetryServiceSpec <DOCATelemetryServiceSpec>`                                        |                                                                                                   |
       +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+