java-docs-samples icon indicating copy to clipboard operation
java-docs-samples copied to clipboard

chore: cleanup unused region tags

Open msampathkumar opened this issue 1 year ago • 5 comments

Adding generativeaionvertexai_ region tags to replace old aiplatform_

In near future GenAI code samples, will only use generativeaionvertexai_ region tag prefix.

Description

Fixes b/355457593

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

  • [x] Please merge this PR for me once it is approved

msampathkumar avatar Jul 29 '24 14:07 msampathkumar

Update: Waiting for CICD check to complete

msampathkumar avatar Jul 29 '24 15:07 msampathkumar

You are about to delete the following sample browser pages.

Here is the summary of changes.

You are about to delete 8 region tags.

This comment is generated by snippet-bot. If you find problems with this result, please file an issue at: https://github.com/googleapis/repo-automation-bots/issues. To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • [ ] Refresh this comment

snippet-bot[bot] avatar Jul 30 '24 13:07 snippet-bot[bot]

Hi @minherz - Updated the summary with bug ticket.

I don't understand something here! I believed that snippet-bot test @ https://github.com/GoogleCloudPlatform/java-docs-samples/pull/9421/checks?check_run_id=28104747679 is to prevent that degradation of user experience. Kindly help me understand.

msampathkumar avatar Aug 09 '24 12:08 msampathkumar

Hi @minherz - Updated the summary with bug ticket.

I don't understand something here! I believed that snippet-bot test @ https://github.com/GoogleCloudPlatform/java-docs-samples/pull/9421/checks?check_run_id=28104747679 is to prevent that degradation of user experience. Kindly help me understand.

Thank you for providing the reasoning behind this change. The description of the linked issue states "After updating the Cloud Docs pages, we need to identify & clear unwanted region tags.".

I did a quick check and indeed majority of the region tags with the generativeaionvertexai_ prefix are represented in the document while the region tags with the suffix aiplatform_ appear only in the Sample Browser. However, I found that the generativeaionvertexai_gemini_single_turn_multi_image region tag does not appear in any documentation. Removing its older version (aiplatform_gemini_single_turn_multi_image) means the documentation degrades.

I also see that the region tag generativeaionvertexai_gemini_get_started is not mentioned in the documentation nor in Sample Browser.

Please, address these two region tags before removing their older versions. There are two options to handle it:

  1. Rollback changes to the two files with these region tags. Merge this PR and then address the changes to these two files in a separate PR.
  2. Verify and fix use of these two region tags in the documentation and merge this PR.

minherz avatar Aug 09 '24 21:08 minherz

Reassigning to @msampathkumar to remaining address comments.

minherz avatar Aug 27 '24 18:08 minherz

Update: I have marked the following region tags for deprecation.

region tags with the suffix aiplatform_ appear only in the Sample Browser.

Working on a fresh PR with more changes.

msampathkumar avatar Aug 29 '24 10:08 msampathkumar