docs: Add page standardization to external tool integrations#2668
docs: Add page standardization to external tool integrations#2668dishaprakash merged 28 commits intodocumentation-reorgfrom
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Link Resolution NoteLocal links and directory changes work differently on GitHub than on the docsite. You must ensure fixes pass the GitHub check and also work with Summary
Errors per inputErrors in DEVELOPER.md
Errors in docs/en/integrations/alloydb-admin/alloydb-create-cluster.md
Errors in docs/en/integrations/alloydb-admin/alloydb-create-instance.md
Errors in docs/en/integrations/alloydb-admin/alloydb-create-user.md
Errors in docs/en/user-guide/connect-to/client-sdks/javascript-sdk/core/index.md
Errors in docs/en/user-guide/connect-to/mcp-client/_index.md
|
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the consistency and maintainability of the project's documentation by introducing and enforcing a standardized structure for all tool integration pages. It includes a new CI linting script to automate checks and updates existing documentation to comply with these new guidelines, making it easier for developers and users to navigate and understand tool functionalities. Highlights
Changelog
Ignored Files
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a new standard for tool documentation pages and updates existing pages to conform to it. A new linting script is added to enforce these standards, which is a great step towards maintaining consistency. The changes across the documentation are extensive and well-executed. I've identified a couple of minor areas for improvement in the new script and one of the updated markdown files.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
🧨 Preview deployments removed. |
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - #2647 - #2648 - #2649 - #2650 - #2652 - #2664 - #2665 - #2666 - #2668 - #2670 - #2723 - #2779 - #2788 - #2790 ## 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: Averi Kitsch <akitsch@google.com>
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - #2647 - #2648 - #2649 - #2650 - #2652 - #2664 - #2665 - #2666 - #2668 - #2670 - #2723 - #2779 - #2788 - #2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - #2647 - #2648 - #2649 - #2650 - #2652 - #2664 - #2665 - #2666 - #2668 - #2670 - #2723 - #2779 - #2788 - #2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
## Description This PR creates the new v1 docsite. ### Documentation Section - Clear use-case based folder structure and navigation ### Integrations Section - New folder structure for each source and compatible tools - Integration specific samples are moved into their folders ### Samples - New samples gallery to search for samples from all across the documentation site - Search and filter based on tags ### Reference - FAQ and CLI details ### Hugo - New secondary top navbar - Increased search capability ## Merge conflicts - versioning.md has been added to path `docs/en/reference/versioning.md` - style-guide has been added to path `docs/en/reference/style-guide.md` ## CloudFlare setup - workflows added to deploy to cloudflare for new release, dev and previous release - individual ephemeral PR preview using cloudflare pages ## Individual PRs - googleapis#2647 - googleapis#2648 - googleapis#2649 - googleapis#2650 - googleapis#2652 - googleapis#2664 - googleapis#2665 - googleapis#2666 - googleapis#2668 - googleapis#2670 - googleapis#2723 - googleapis#2779 - googleapis#2788 - googleapis#2790 ## 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: Averi Kitsch <akitsch@google.com> 5b25ce0
Description
This PR adds page standardization rules for the tool pages.
The proposed standard for tool pages is:
Frontmatter title must end with "Tool"
#H1 heading as title acts as the heading## About(Required)## Compatible Sources(Optional)## Requirements(Optional)## Parameters(Optional)## Example(Required)## Output Format(Optional)## Reference(Optional)## Advanced Usage(Optional)## Troubleshooting(Optional)## Additional Resources(Optional)This structure was chosen as the tools page vary widely between integrations
If the
## Compatible Sourcesheading is used, the {{< compatible-sources >}} shortcode must be placed directly beneath it.The existing lint-docs.yml GHA Workflow is updated to conduct this CI check alongside the source pages, which runs the .ci/lint-docs-tool-page.sh script which has the bash script for the above mentioned check
PR 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>