Skip to content

Commit 8495d3f

Browse files
jskeetjskeet
authored
chore: address product documentation in googleapis-common-protos (#16841)
- Remove the product_documentation_override - Add a string replacement to remove inappropriate lines Completes the google-cloud-python part of #5466 Filed googleapis/librarian#5670 to remove the need for the string replacement when we migrate synthtool code into librarian.
1 parent ab842a3 commit 8495d3f

5 files changed

Lines changed: 71 additions & 24 deletions

File tree

‎.librarian/generator-input/client-post-processing/googleapis-common-protos-docs.yaml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Copyright 2026 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
description: Remove inappropriate product documentation lines in googleapis-common-protos readme
15+
url: https://github.com/googleapis/librarian/issues/5670
16+
replacements:
17+
- paths: [
18+
packages/googleapis-common-protos/README.rst
19+
]
20+
before: "`Google APIs Common Protos`_: Lets you define and config your API service.\n\n"
21+
after: ""
22+
count: 1
23+
- paths: [
24+
packages/googleapis-common-protos/README.rst
25+
]
26+
before: "- `Product Documentation`_\n"
27+
after: ""
28+
count: 1
29+
- paths: [
30+
packages/googleapis-common-protos/README.rst
31+
]
32+
before: ".. _Google APIs Common Protos: \n"
33+
after: ""
34+
count: 1
35+
- paths: [
36+
packages/googleapis-common-protos/README.rst
37+
]
38+
before: ".. _Product Documentation: \n"
39+
after: ""
40+
count: 1
41+
- paths: [
42+
packages/googleapis-common-protos/README.rst
43+
]
44+
before: |
45+
3. `Enable the Google APIs Common Protos.`_
46+
4. `Set up Authentication.`_
47+
after: |
48+
3. `Set up Authentication.`_
49+
count: 1
50+
- paths: [
51+
packages/googleapis-common-protos/README.rst
52+
]
53+
before: ".. _Enable the Google APIs Common Protos.: \n"
54+
after: ""
55+
count: 1
56+
- paths: [
57+
packages/googleapis-common-protos/README.rst
58+
]
59+
before: |
60+
- Read the `Google APIs Common Protos Product documentation`_ to learn
61+
more about the product and see How-to Guides.
62+
after: ""
63+
count: 1
64+
- paths: [
65+
packages/googleapis-common-protos/README.rst
66+
]
67+
before: ".. _Google APIs Common Protos Product documentation: \n"
68+
after: ""
69+
count: 1

‎librarian.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2957,7 +2957,6 @@ libraries:
29572957
- google/logging/type
29582958
- google/rpc/context
29592959
name_pretty_override: Google APIs Common Protos
2960-
product_documentation_override: https://github.com/googleapis/googleapis/tree/master/google
29612960
client_documentation_override: https://github.com/googleapis/google-cloud-python/tree/main/packages/googleapis-common-protos
29622961
default_version: apiVersion
29632962
- name: grafeas

‎packages/googleapis-common-protos/.repo-metadata.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
"library_type": "CORE",
1010
"name": "googleapis-common-protos",
1111
"name_pretty": "Google APIs Common Protos",
12-
"product_documentation": "https://github.com/googleapis/googleapis/tree/master/google",
1312
"release_level": "stable",
1413
"repo": "googleapis/google-cloud-python"
1514
}

‎packages/googleapis-common-protos/README.rst‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,15 @@ Python Client for Google APIs Common Protos
33

44
|stable| |pypi| |versions|
55

6-
`Google APIs Common Protos`_: Lets you define and config your API service.
7-
86
- `Client Library Documentation`_
9-
- `Product Documentation`_
107

118
.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
129
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
1310
.. |pypi| image:: https://img.shields.io/pypi/v/googleapis-common-protos.svg
1411
:target: https://pypi.org/project/googleapis-common-protos/
1512
.. |versions| image:: https://img.shields.io/pypi/pyversions/googleapis-common-protos.svg
1613
:target: https://pypi.org/project/googleapis-common-protos/
17-
.. _Google APIs Common Protos: https://github.com/googleapis/googleapis/tree/master/google
1814
.. _Client Library Documentation: https://github.com/googleapis/google-cloud-python/tree/main/packages/googleapis-common-protos/summary_overview
19-
.. _Product Documentation: https://github.com/googleapis/googleapis/tree/master/google
2015

2116
Quick Start
2217
-----------
@@ -25,12 +20,10 @@ In order to use this library, you first need to go through the following steps:
2520

2621
1. `Select or create a Cloud Platform project.`_
2722
2. `Enable billing for your project.`_
28-
3. `Enable the Google APIs Common Protos.`_
29-
4. `Set up Authentication.`_
23+
3. `Set up Authentication.`_
3024

3125
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3226
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33-
.. _Enable the Google APIs Common Protos.: https://github.com/googleapis/googleapis/tree/master/google
3427
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3528

3629
Installation
@@ -99,12 +92,9 @@ Next Steps
9992

10093
- Read the `Client Library Documentation`_ for Google APIs Common Protos
10194
to see other available methods on the client.
102-
- Read the `Google APIs Common Protos Product documentation`_ to learn
103-
more about the product and see How-to Guides.
10495
- View this `README`_ to see the full list of Cloud
10596
APIs that we cover.
10697

107-
.. _Google APIs Common Protos Product documentation: https://github.com/googleapis/googleapis/tree/master/google
10898
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
10999

110100
Logging

‎packages/googleapis-common-protos/docs/README.rst‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,15 @@ Python Client for Google APIs Common Protos
33

44
|stable| |pypi| |versions|
55

6-
`Google APIs Common Protos`_: Lets you define and config your API service.
7-
86
- `Client Library Documentation`_
9-
- `Product Documentation`_
107

118
.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg
129
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
1310
.. |pypi| image:: https://img.shields.io/pypi/v/googleapis-common-protos.svg
1411
:target: https://pypi.org/project/googleapis-common-protos/
1512
.. |versions| image:: https://img.shields.io/pypi/pyversions/googleapis-common-protos.svg
1613
:target: https://pypi.org/project/googleapis-common-protos/
17-
.. _Google APIs Common Protos: https://github.com/googleapis/googleapis/tree/master/google
1814
.. _Client Library Documentation: https://github.com/googleapis/google-cloud-python/tree/main/packages/googleapis-common-protos/summary_overview
19-
.. _Product Documentation: https://github.com/googleapis/googleapis/tree/master/google
2015

2116
Quick Start
2217
-----------
@@ -25,12 +20,10 @@ In order to use this library, you first need to go through the following steps:
2520

2621
1. `Select or create a Cloud Platform project.`_
2722
2. `Enable billing for your project.`_
28-
3. `Enable the Google APIs Common Protos.`_
29-
4. `Set up Authentication.`_
23+
3. `Set up Authentication.`_
3024

3125
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3226
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33-
.. _Enable the Google APIs Common Protos.: https://github.com/googleapis/googleapis/tree/master/google
3427
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3528

3629
Installation
@@ -99,12 +92,9 @@ Next Steps
9992

10093
- Read the `Client Library Documentation`_ for Google APIs Common Protos
10194
to see other available methods on the client.
102-
- Read the `Google APIs Common Protos Product documentation`_ to learn
103-
more about the product and see How-to Guides.
10495
- View this `README`_ to see the full list of Cloud
10596
APIs that we cover.
10697

107-
.. _Google APIs Common Protos Product documentation: https://github.com/googleapis/googleapis/tree/master/google
10898
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
10999

110100
Logging

0 commit comments

Comments
 (0)