Doc fixes 1.17 (#10360)

Co-authored-by: Rachael Graham <rachael.graham@solo.io> Co-authored-by: Art <artberger@users.noreply.github.com>
solo-io · Nov 22, 2024 · 0f9dde2 · 0f9dde2
1 parent 76c3470
commit 0f9dde2
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 10 deletions.
diff --git a/.github/workflows/push-docs.yaml b/.github/workflows/push-docs.yaml
@@ -25,6 +25,8 @@ jobs:
 
   copy-docs:
     runs-on: ubuntu-latest
+    outputs:
+      minor: ${{ steps.version-variables.outputs.minor }}
     steps:
     - name: Get LTS branch version
       id: lts-version
@@ -162,16 +164,17 @@ jobs:
 
   slack-notification:
     runs-on: ubuntu-latest
-    needs:
-      - copy-docs
+    if: ${{ always() }}
+    needs: copy-docs
     steps:
     - name: Notify on workflow success
       if: |
         needs.copy-docs.result == 'success'
       env:
         SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+        VERSION: ${{needs.copy-docs.outputs.minor}}
       run: |
-        MESSAGE="✅ *Success:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} was successful. <https://github.com/solo-io/docs/pulls|Review the PR>"
+        MESSAGE="✅ *Success:* Automated copy of reference docs for ${VERSION} was successful. <https://github.com/solo-io/docs/pulls|Review the PR>"
 
         curl \
           -d "text=$MESSAGE" \
@@ -185,7 +188,7 @@ jobs:
         SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
       run: |
         JOB_URL=https://github.com/solo-io/gloo/actions/runs/${GITHUB_RUN_ID}
-        MESSAGE="❌ *Failure:* Automated copy of reference docs for ${{ steps.version-variables.outputs.minor }} failed. <${JOB_URL}|Review the workflow failure>"
+        MESSAGE="❌ *Failure:* Automated copy of reference docs for ${VERSION} failed. <${JOB_URL}|Review the workflow failure>"
 
         curl \
           -d "text=$MESSAGE" \

diff --git a/changelog/v1.17.16/doc-fixes.yaml b/changelog/v1.17.16/doc-fixes.yaml
@@ -2,4 +2,4 @@ changelog:
   - type: NON_USER_FACING
     description: >-
       Weekly doc fixes, including API proto doc format changes and an update to the copy-docs workflow.
-      skipCI-kube-tests:true
+      skipCI-kube-tests:true
diff --git a/docs/content/reference/api/_index.md b/docs/content/reference/api/_index.md
@@ -26,10 +26,10 @@ Settings
 
 Routing
 - VirtualService: {{< protobuf name="gateway.solo.io.VirtualService" >}}
-  - Options: {{< protobuf name="gloo.solo.io.VirtualHostOptions" >}}
+  - Options: {{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options.proto.sk/#virtualhostoptions" >}}
 - RouteTable: {{< protobuf name="gateway.solo.io.RouteTable" >}}
 - Routes: {{< protobuf name="gateway.solo.io.Route" >}} 
-  - Options: {{< protobuf name="gloo.solo.io.RouteOptions" >}}
+  - Options: {{< versioned_link_path fromRoot="/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options.proto.sk/#routeoptions" >}}
 - Upstream: {{< protobuf name="gloo.solo.io.Upstream" >}}
 
 ExtAuth

diff --git a/docs/content/reference/cheatsheets/timeouts/_index.md b/docs/content/reference/cheatsheets/timeouts/_index.md
@@ -81,7 +81,7 @@ Review this page for a list of commonly used timeout settings in Gloo Gateway, o
   - `sslConfig`
     - `transportSocketConnectTimeout` disabled by default, **unlimited** (or limited by connection/idle timeout). Suggested is 10 seconds.
   - `virtualHost`
-    - `options` (see also {{< protobuf name="gloo.solo.io.VirtualHostOptions" display="VirtualHostOptions" >}} )
+    - `options` (see also {{< protobuf name="gloo.solo.io.Options" display="Options" >}} )
       - `retries`
         - `perTryTimeout` defaults to **15 seconds** (Route timeout)
       - `jwtStaged`
@@ -91,7 +91,7 @@ Review this page for a list of commonly used timeout settings in Gloo Gateway, o
               - `remote`
                 - `cacheDuration` defaults to **5 minutes**
     - `routes`
-      - `options` (see also {{< protobuf name="gloo.solo.io.RouteOptions" display="RouteOptions" >}})
+      - `options` (see also {{< protobuf name="gloo.solo.io.Options" display="Options" >}})
         - `timeout` defaults to **15 seconds**
         - `retries`
           - `perTryTimeout` defaults to **15 seconds** (Route timeout)
@@ -123,4 +123,4 @@ Review this page for a list of commonly used timeout settings in Gloo Gateway, o
     - `unhealthyEdgeInterval` defaults to `unhealthyInterval`'s value
     - `healthyEdgeInterval` defaults to `interval`'s value
 
-
+