Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add endpoint override snippets to generated libs #10129

Merged

Conversation

coryan
Copy link
Contributor

@coryan coryan commented Oct 29, 2022

Modify the landing pages for all the generated libraries to include a
snippet showing how to override the endpoint for the *Client.

In libraries where there is more than one *Client injecting a
snippet for each *Client looked too cluttered. The script injects the
first (in alphabetical order) snippet into the landing page. The
remaining snippets are referenced from that page, but are in
separate pages.

Part of the work for #10114

The main page for a service now looks like this (click on the image to embiggen):

image

While each one of the referenced pages looks like this:

image


This change is Reviewable

Modify the landing pages for all the generated libraries to include a
snippet showing how to override the endpoint for the `*Client`.

In libraries where there is more than one `*Client` injecting a
snippet for each `*Client` looked too cluttered. The script injects the
first (in alphabetical order) snippet into the landing page. The
remaining snippets are referenced from that page, but are in
separate pages.
@google-cloud-cpp-bot
Copy link
Collaborator

Google Cloud Build Logs
For commit: e561972a3644d04a0937102dd334e2b76f5b4c6a

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

@codecov
Copy link

codecov bot commented Oct 29, 2022

Codecov Report

Base: 93.97% // Head: 93.98% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (e561972) compared to base (7c6c86e).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10129   +/-   ##
=======================================
  Coverage   93.97%   93.98%           
=======================================
  Files        1523     1523           
  Lines      140149   140149           
=======================================
+ Hits       131709   131713    +4     
+ Misses       8440     8436    -4     
Impacted Files Coverage Δ
...integration_tests/schema_admin_integration_test.cc 98.88% <0.00%> (-1.12%) ⬇️
google/cloud/pubsub/samples/samples.cc 90.77% <0.00%> (+0.07%) ⬆️
.../internal/subscription_concurrency_control_test.cc 100.00% <0.00%> (+0.26%) ⬆️
...ud/spanner/integration_tests/client_stress_test.cc 84.86% <0.00%> (+0.65%) ⬆️
...bigtable/examples/bigtable_hello_instance_admin.cc 83.00% <0.00%> (+2.00%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@coryan coryan marked this pull request as ready for review October 29, 2022 17:17
@coryan coryan requested a review from a team as a code owner October 29, 2022 17:17
@coryan coryan merged commit 6336ea7 into googleapis:main Oct 29, 2022
@coryan coryan deleted the feat-generator-basic-client-samples-pr6 branch October 29, 2022 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants