docs: Add prebuilt configs under integrations and add migration banner#2857
docs: Add prebuilt configs under integrations and add migration banner#2857
Conversation
|
🚀 Cloudflare Preview Ready! 🔎 View Preview: https://pr-2857.toolbox-docs-6xc.pages.dev (Note: Subsequent pushes to this PR will automatically update the preview at this same URL) |
There was a problem hiding this comment.
Code Review
This pull request refactors the prebuilt configurations documentation by migrating content from a single large file into individual, integration-specific markdown files. It introduces a new Hugo shortcode, list-prebuilt-configs, to dynamically aggregate and display these configurations across the site. Feedback was provided regarding a missing newline at the end of the new shortcode layout file to ensure proper formatting.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
🧨 Preview deployments removed. Cloudflare Pages environments for |
|
🧨 Preview deployments removed. |
…on banner (#2857) ## Description This PR : - Splits the complete list of prebuilt configs adds the config specific each source under the `integrations/` section. - A shortcode has been added to link these files in the `documentation/configuration/prebuilt-configs/_index.md` - Adds migration banner to redirect users to new url - Adds documentation for contributors on file structure for both samples and prebuilt configs ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> 837047b
…on banner (#2857) ## Description This PR : - Splits the complete list of prebuilt configs adds the config specific each source under the `integrations/` section. - A shortcode has been added to link these files in the `documentation/configuration/prebuilt-configs/_index.md` - Adds migration banner to redirect users to new url - Adds documentation for contributors on file structure for both samples and prebuilt configs ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> 837047b
…on banner (googleapis#2857) ## Description This PR : - Splits the complete list of prebuilt configs adds the config specific each source under the `integrations/` section. - A shortcode has been added to link these files in the `documentation/configuration/prebuilt-configs/_index.md` - Adds migration banner to redirect users to new url - Adds documentation for contributors on file structure for both samples and prebuilt configs ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> 837047b
…on banner (googleapis#2857) ## Description This PR : - Splits the complete list of prebuilt configs adds the config specific each source under the `integrations/` section. - A shortcode has been added to link these files in the `documentation/configuration/prebuilt-configs/_index.md` - Adds migration banner to redirect users to new url - Adds documentation for contributors on file structure for both samples and prebuilt configs ## PR Checklist > Thank you for opening a Pull Request! Before submitting your PR, there are a > few things you can do to make sure it goes smoothly: - [x] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) - [x] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #<issue_number_goes_here> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com> 837047b
Description
This PR :
integrations/section.documentation/configuration/prebuilt-configs/_index.mdPR Checklist
CONTRIBUTING.md
bug/issue
before writing your code! That way we can discuss the change, evaluate
designs, and agree on the general idea
!if this involve a breaking change🛠️ Fixes #<issue_number_goes_here>