Doc fixes [1.19] (#10526)

Co-authored-by: Art Berger <[email protected]>
solo-io · Dec 20, 2024 · e4c1ee9 · e4c1ee9
1 parent a8f776e
commit e4c1ee9
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 15 deletions.
diff --git a/.github/workflows/push-docs.yaml b/.github/workflows/push-docs.yaml
@@ -110,19 +110,19 @@ jobs:
       run: |
         pushd docs || exit 1
         # OSS
-        cp ../gloo/docs/content/static/content/gloo-security-scan.docgen static/content/gg-security-updates/gloo-security-scan.docgen
-        cp ../gloo/docs/content/static/content/gloo-security-scan-0.docgen static/content/gg-security-updates/gloo-security-scan-0.docgen
-        cp ../gloo/docs/content/static/content/gloo-security-scan-1.docgen static/content/gg-security-updates/gloo-security-scan-1.docgen
-        cp ../gloo/docs/content/static/content/gloo-security-scan-2.docgen static/content/gg-security-updates/gloo-security-scan-2.docgen
-        cp ../gloo/docs/content/static/content/gloo-security-scan-3.docgen static/content/gg-security-updates/gloo-security-scan-3.docgen
-        cp ../gloo/docs/content/static/content/gloo-security-scan-4.docgen static/content/gg-security-updates/gloo-security-scan-4.docgen
+        [ -f ../gloo/docs/content/static/content/gloo-security-scan.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan.docgen static/content/gg-security-updates/gloo-security-scan.docgen
+        [ -f ../gloo/docs/content/static/content/gloo-security-scan-0.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-0.docgen static/content/gg-security-updates/gloo-security-scan-0.docgen
+        [ -f ../gloo/docs/content/static/content/gloo-security-scan-1.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-1.docgen static/content/gg-security-updates/gloo-security-scan-1.docgen
+        [ -f ../gloo/docs/content/static/content/gloo-security-scan-2.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-2.docgen static/content/gg-security-updates/gloo-security-scan-2.docgen
+        [ -f ../gloo/docs/content/static/content/gloo-security-scan-3.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-3.docgen static/content/gg-security-updates/gloo-security-scan-3.docgen
+        [ -f ../gloo/docs/content/static/content/gloo-security-scan-4.docgen ] && cp ../gloo/docs/content/static/content/gloo-security-scan-4.docgen static/content/gg-security-updates/gloo-security-scan-4.docgen
         # Enterprise
-        cp ../gloo/docs/content/static/content/glooe-security-scan.docgen static/content/gg-security-updates/glooe-security-scan.docgen
-        cp ../gloo/docs/content/static/content/glooe-security-scan-0.docgen static/content/gg-security-updates/glooe-security-scan-0.docgen
-        cp ../gloo/docs/content/static/content/glooe-security-scan-1.docgen static/content/gg-security-updates/glooe-security-scan-1.docgen
-        cp ../gloo/docs/content/static/content/glooe-security-scan-2.docgen static/content/gg-security-updates/glooe-security-scan-2.docgen
-        cp ../gloo/docs/content/static/content/glooe-security-scan-3.docgen static/content/gg-security-updates/glooe-security-scan-3.docgen
-        cp ../gloo/docs/content/static/content/glooe-security-scan-4.docgen static/content/gg-security-updates/glooe-security-scan-4.docgen
+        [ -f ../gloo/docs/content/static/content/glooe-security-scan.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan.docgen static/content/gg-security-updates/glooe-security-scan.docgen
+        [ -f ../gloo/docs/content/static/content/glooe-security-scan-0.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-0.docgen static/content/gg-security-updates/glooe-security-scan-0.docgen
+        [ -f ../gloo/docs/content/static/content/glooe-security-scan-1.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-1.docgen static/content/gg-security-updates/glooe-security-scan-1.docgen
+        [ -f ../gloo/docs/content/static/content/glooe-security-scan-2.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-2.docgen static/content/gg-security-updates/glooe-security-scan-2.docgen
+        [ -f ../gloo/docs/content/static/content/glooe-security-scan-3.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-3.docgen static/content/gg-security-updates/glooe-security-scan-3.docgen
+        [ -f ../gloo/docs/content/static/content/glooe-security-scan-4.docgen ] && cp ../gloo/docs/content/static/content/glooe-security-scan-4.docgen static/content/gg-security-updates/glooe-security-scan-4.docgen
         popd || exit 1
     - name: Copy security posture
       run: |
@@ -151,6 +151,14 @@ jobs:
         cp ../gloo/docs/content/reference/cli/glooctl_uninstall.md content/en/gateway/${{ steps.version-variables.outputs.directory }}/reference/cli/glooctl_uninstall.md
         cp ../gloo/docs/content/reference/cli/glooctl_upgrade.md content/en/gateway/${{ steps.version-variables.outputs.directory }}/reference/cli/glooctl_upgrade.md
         popd || exit 1
+    - name: Copy API
+      run: |
+        pushd docs || exit 1
+        cp ../gloo/docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/direct_responses.md assets/conrefs/pages/gateway/reference/direct_responses_${{ steps.lts-version.outputs.lts }}.md
+        sed -i '1,2d' assets/conrefs/pages/gateway/reference/direct_responses_${{ steps.lts-version.outputs.lts }}.md
+        cp ../gloo/docs/content/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/gateway_parameters.md assets/conrefs/pages/gateway/reference/gateway_parameters_${{ steps.lts-version.outputs.lts }}.md
+        sed -i '1,2d' assets/conrefs/pages/gateway/reference/gateway_parameters_${{ steps.lts-version.outputs.lts }}.md
+        popd || exit 1
     - name: Push and create PR
       env:
         GITHUB_TOKEN: ${{ secrets.DOCS_TOKEN }}

diff --git a/changelog/v1.19.0-beta3/docs-fixes.yaml b/changelog/v1.19.0-beta3/docs-fixes.yaml
@@ -0,0 +1,5 @@
+changelog:
+  - type: NON_USER_FACING
+    description: >-
+      Weekly doc fixes, such as links, typos, and minor Slack requests.
+      skipCI-kube-tests:true
diff --git a/docs/content/guides/graphql/observability.md b/docs/content/guides/graphql/observability.md
@@ -69,5 +69,7 @@ If you encounter errors or unexpected behavior in your Gloo GraphQL setup, you c
    {{< /highlight >}}
 
 3. Use the following command. Logs are now collected for your GraphQL resources, and are served by the gateway proxy pod.
+
    ```sh
-   glooctl proxy logs debug
+   glooctl proxy logs --name gateway-proxy debug
+   ```
diff --git a/docs/content/introduction/faq.md b/docs/content/introduction/faq.md
@@ -398,7 +398,7 @@ You can then compare the output to what the Envoy config should look like.
 If you want to quickly get the logs for the proxy:
 
 ```bash
-glooctl proxy logs -f
+glooctl proxy logs --name gateway-proxy -f
 ```
 
 ### Why are the ports on my gateway proxy not opened?

diff --git a/docs/content/operations/debugging_gloo/_index.md b/docs/content/operations/debugging_gloo/_index.md
@@ -167,7 +167,7 @@ Finally, you can use the Solo.io Envoy UI to browse the config. You can safely u
 If things look okay (within your ability to tell), another good place to look is the Envoy proxy logs. You can very quickly turn on `debug` logging to Envoy as well as `tail` the logs with this handy `glooctl` command:
 
 ```bash
-glooctl proxy logs -f
+glooctl proxy logs --name gateway-proxy -f
 ```
 
 When you have the logging window up, send requests through to the proxy and you can get some very detailed debugging logging going through the log tail.