chore: migrate remaining libraries to librarian#16616
chore: migrate remaining libraries to librarian#16616jskeet wants to merge 5 commits intogoogleapis:mainfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the repository metadata and documentation for numerous Google Cloud Python client libraries. The changes include standardizing the structure of .repo-metadata.json files, adding missing README.rst files, and updating descriptions. My review identified a few issues: the release_level for bigquery-magics was incorrectly downgraded to preview, a boolean value in the django-google-spanner documentation is incorrectly formatted as false instead of False, and HTML <br> tags are being used in documentation and metadata, which are not supported in reStructuredText and should be replaced with proper paragraph spacing.
| "name": "bigquery-magics", | ||
| "name_pretty": "Google BigQuery connector for Jupyter and IPython", | ||
| "product_documentation": "https://cloud.google.com/bigquery", | ||
| "release_level": "preview", |
There was a problem hiding this comment.
The release_level has been changed from stable to preview. Downgrading the release status of a library is unusual and might be an accidental change during migration, especially since the corresponding README.rst still references General Availability (GA) support.
| "release_level": "preview", | |
| "release_level": "stable", |
| 'PROJECT': '$PROJECT', | ||
| 'INSTANCE': '$INSTANCE', | ||
| 'NAME': '$DATABASE', | ||
| 'RANDOM_ID_GENERATION_ENABLED': false, |
There was a problem hiding this comment.
In Python, the boolean value should be False (capitalized). Using false will result in a NameError when this configuration is used in a Django settings file, as indicated by the .. code:: python directive above.
| 'RANDOM_ID_GENERATION_ENABLED': false, | |
| "RANDOM_ID_GENERATION_ENABLED": False, |
| "product_documentation": "https://cloud.google.com/alloydb/", | ||
| "release_level": "preview", | ||
| "repo": "googleapis/google-cloud-python" | ||
| "api_description": "AlloyDB for PostgreSQL is an open source-compatible database service that\nprovides a powerful option for migrating, modernizing, or building\ncommercial-grade applications. It offers full compatibility with standard\nPostgreSQL, and is more than 4x faster for transactional workloads and up\nto 100x faster for analytical queries than standard PostgreSQL in our\nperformance tests. AlloyDB for PostgreSQL offers a 99.99 percent\navailability SLA inclusive of maintenance. \u003cbr\u003e\u003cbr\u003e AlloyDB is optimized\nfor the most demanding use cases, allowing you to build new applications\nthat require high transaction throughput, large database sizes, or\nmultiple read resources; scale existing PostgreSQL workloads with no\napplication changes; and modernize legacy proprietary databases.", |
There was a problem hiding this comment.
The api_description contains HTML
tags. Since this description is used to generate documentation in reStructuredText (RST) format (e.g., in README.rst), these tags will not be rendered correctly and will appear as literal text. Consider using escaped newlines (\n) instead.
| PostgreSQL, and is more than 4x faster for transactional workloads and up | ||
| to 100x faster for analytical queries than standard PostgreSQL in our | ||
| performance tests. AlloyDB for PostgreSQL offers a 99.99 percent | ||
| availability SLA inclusive of maintenance. <br><br> AlloyDB is optimized |
There was a problem hiding this comment.
The use of HTML
tags is not standard in reStructuredText (RST). They will likely be rendered literally in most viewers. Use a blank line to separate paragraphs instead.
| availability SLA inclusive of maintenance. <br><br> AlloyDB is optimized | |
| availability SLA inclusive of maintenance. | |
| AlloyDB is optimized |
The following libraries are generation-blocked, which will be resolved soon (in different PRs):