From cdfd9ef4567b0b29e5528c6e90e76d55bf0434b0 Mon Sep 17 00:00:00 2001 From: Rachael Graham Date: Mon, 23 Dec 2024 14:57:53 -0600 Subject: [PATCH] [1.17 backport] Docs: workflow adjustment, version bumps (#10533) Co-authored-by: Art Berger --- .github/workflows/push-docs.yaml | 28 ++++++++++--------- changelog/v1.17.20/docs-fixes.yaml | 5 ++++ docs/content/guides/graphql/observability.md | 4 ++- docs/content/introduction/faq.md | 2 +- .../operations/debugging_gloo/_index.md | 2 +- .../static/content/version_gee_latest.md | 2 +- .../content/static/content/version_gee_n+1.md | 2 +- .../static/content/version_geoss_latest.md | 2 +- .../static/content/version_geoss_n+1.md | 2 +- .../static/content/version_geoss_n-1.md | 2 +- 10 files changed, 30 insertions(+), 21 deletions(-) create mode 100644 changelog/v1.17.20/docs-fixes.yaml diff --git a/.github/workflows/push-docs.yaml b/.github/workflows/push-docs.yaml index 2a8ccc521eb..323d5e9d3f3 100644 --- a/.github/workflows/push-docs.yaml +++ b/.github/workflows/push-docs.yaml @@ -25,6 +25,8 @@ jobs: copy-docs: runs-on: ubuntu-latest + if: ${{ always() }} + needs: receiver outputs: minor: ${{ steps.version-variables.outputs.minor }} steps: @@ -35,7 +37,7 @@ jobs: if [[ "${{ github.event_name }}" == "release" ]]; then version=${{ github.event.release.target_commitish }} elif [[ "${{ github.event_name }}" == "repository_dispatch" ]]; then - version=${{ steps.dispatch-receiver.outputs.dispatch_lts }} + version=${{ needs.receiver.outputs.dispatch_lts }} else version=${{ inputs.branch }} fi @@ -110,19 +112,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: | diff --git a/changelog/v1.17.20/docs-fixes.yaml b/changelog/v1.17.20/docs-fixes.yaml new file mode 100644 index 00000000000..61a9f4db341 --- /dev/null +++ b/changelog/v1.17.20/docs-fixes.yaml @@ -0,0 +1,5 @@ +changelog: + - type: NON_USER_FACING + description: >- + Weekly backport of doc fixes, such as links, typos, version bumps, and minor Slack requests. + skipCI-kube-tests:true \ No newline at end of file diff --git a/docs/content/guides/graphql/observability.md b/docs/content/guides/graphql/observability.md index 75815c4d2d7..bd8b2e67b13 100644 --- 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 \ No newline at end of file + glooctl proxy logs --name gateway-proxy debug + ``` \ No newline at end of file diff --git a/docs/content/introduction/faq.md b/docs/content/introduction/faq.md index 87965d174fb..cf20b184a40 100644 --- 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 index 8918796a178..3b83a1a3b44 100644 --- 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. diff --git a/docs/content/static/content/version_gee_latest.md b/docs/content/static/content/version_gee_latest.md index 250f3597453..74921a9666c 100644 --- a/docs/content/static/content/version_gee_latest.md +++ b/docs/content/static/content/version_gee_latest.md @@ -1 +1 @@ -1.17.4 \ No newline at end of file +1.17.5 \ No newline at end of file diff --git a/docs/content/static/content/version_gee_n+1.md b/docs/content/static/content/version_gee_n+1.md index e4b5c5fd145..5ce8b395998 100644 --- a/docs/content/static/content/version_gee_n+1.md +++ b/docs/content/static/content/version_gee_n+1.md @@ -1 +1 @@ -1.18.0-rc3 \ No newline at end of file +1.18.1 \ No newline at end of file diff --git a/docs/content/static/content/version_geoss_latest.md b/docs/content/static/content/version_geoss_latest.md index c4897c26a76..e18a07869a9 100644 --- a/docs/content/static/content/version_geoss_latest.md +++ b/docs/content/static/content/version_geoss_latest.md @@ -1 +1 @@ -1.17.16 \ No newline at end of file +1.17.19 \ No newline at end of file diff --git a/docs/content/static/content/version_geoss_n+1.md b/docs/content/static/content/version_geoss_n+1.md index e4b5c5fd145..753029c3a5e 100644 --- a/docs/content/static/content/version_geoss_n+1.md +++ b/docs/content/static/content/version_geoss_n+1.md @@ -1 +1 @@ -1.18.0-rc3 \ No newline at end of file +1.18.2 \ No newline at end of file diff --git a/docs/content/static/content/version_geoss_n-1.md b/docs/content/static/content/version_geoss_n-1.md index a515392c46f..2fc303a46cc 100644 --- a/docs/content/static/content/version_geoss_n-1.md +++ b/docs/content/static/content/version_geoss_n-1.md @@ -1 +1 @@ -1.16.22 \ No newline at end of file +1.16.23 \ No newline at end of file