From cd4b35e108a907a975f993aa5e07c7be548eac87 Mon Sep 17 00:00:00 2001 From: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com> Date: Wed, 5 Feb 2025 21:32:39 -0700 Subject: [PATCH] chore: make docs public (#274) --- .github/workflows/docs_deploy.yaml | 4 +--- .github/workflows/docs_preview_deploy.yaml | 6 ++---- README.md | 10 +++++----- docs/en/resources/_index.md | 2 +- 4 files changed, 9 insertions(+), 13 deletions(-) diff --git a/.github/workflows/docs_deploy.yaml b/.github/workflows/docs_deploy.yaml index e1050e85b..1e5963025 100644 --- a/.github/workflows/docs_deploy.yaml +++ b/.github/workflows/docs_deploy.yaml @@ -65,9 +65,7 @@ jobs: - run: npm ci - run: hugo --minify env: - # HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.repository }} - # While private, GitHub uses an obfuscated url instead: - HUGO_BASEURL: https://vigilant-guacamole-plnwrm9.pages.github.io/ + HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/ HUGO_RELATIVEURLS: false - name: Deploy diff --git a/.github/workflows/docs_preview_deploy.yaml b/.github/workflows/docs_preview_deploy.yaml index fa30be3d0..ccbb84094 100644 --- a/.github/workflows/docs_preview_deploy.yaml +++ b/.github/workflows/docs_preview_deploy.yaml @@ -65,9 +65,7 @@ jobs: - run: npm ci - run: hugo --minify env: - # HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.repository }}/previews/PR-${{ github.event.number }}/ - # While private, GitHub uses an obfuscated url instead: - HUGO_BASEURL: https://vigilant-guacamole-plnwrm9.pages.github.io/previews/PR-${{ github.event.number }}/ + HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/PR-${{ github.event.number }}/ HUGO_ENVIRONMENT: preview HUGO_RELATIVEURLS: false @@ -91,5 +89,5 @@ jobs: issue_number: context.payload.number, owner: context.repo.owner, repo: context.repo.repo, - body: "🔎 Preview at https://vigilant-guacamole-plnwrm9.pages.github.io/previews/PR-${{ github.event.number }}/" + body: "🔎 Preview at https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/PR-${{ github.event.number }}/" }) \ No newline at end of file diff --git a/README.md b/README.md index 162934e16..d7d86659c 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ tools easier, faster, and more securely by handling the complexities such as connection pooling, authentication, and more. This README provides a brief overview. For comprehensive details, see the full -[documentation](https://vigilant-guacamole-plnwrm9.pages.github.io/). +[documentation](https://googleapis.github.io/genai-toolbox/). ## Table of Contents @@ -119,7 +119,7 @@ terminate signal (`ctrl+c` on most platforms). For more detailed documentation on deploying to different environments, check out the resources in the [How-to -section](https://vigilant-guacamole-plnwrm9.pages.github.io/how-to/) +section](https://googleapis.github.io/genai-toolbox/how-to/) ### Integrating your application @@ -157,7 +157,7 @@ have multiple files, you can tell toolbox which to load with the `--tools_file tools.yaml` flag. You can find more detailed reference documentation to all resource types in the -[Resources](https://vigilant-guacamole-plnwrm9.pages.github.io/resources/). +[Resources](https://googleapis.github.io/genai-toolbox/resources/). ### Sources The `sources` section of your `tools.yaml` defines what data sources your @@ -176,7 +176,7 @@ sources: ``` For more details on configuring different types of sources, see the -[Sources](https://vigilant-guacamole-plnwrm9.pages.github.io/resources/sources/. +[Sources](https://googleapis.github.io/genai-toolbox/resources/sources/. ### Tools @@ -198,7 +198,7 @@ tools: ``` For more details on configuring different types of tools, see the -[Tools](https://vigilant-guacamole-plnwrm9.pages.github.io/resources/tools). +[Tools](https://googleapis.github.io/genai-toolbox/resources/tools). ### Toolsets diff --git a/docs/en/resources/_index.md b/docs/en/resources/_index.md index ac3203830..a0301aae9 100644 --- a/docs/en/resources/_index.md +++ b/docs/en/resources/_index.md @@ -2,5 +2,5 @@ title: "Resources" type: docs weight: 4 -description: List of reference documentation for resources in Toolbox +description: List of reference documentation for resources in Toolbox. ---