Skip to content

Conversation

@alvarowolfx
Copy link
Collaborator

Improvements to Signer docs:

  • Add warning about using Service Account
  • Link to what is ADC.

Towards #3645

@alvarowolfx alvarowolfx requested review from a team as code owners January 9, 2026 04:56
@codecov
Copy link

codecov bot commented Jan 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.77%. Comparing base (aba90f6) to head (d2bb629).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4201      +/-   ##
==========================================
+ Coverage   94.76%   94.77%   +0.01%     
==========================================
  Files         187      187              
  Lines        7106     7106              
==========================================
+ Hits         6734     6735       +1     
+ Misses        372      371       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines +50 to +53
//! <div class="warning">
//! <strong>Caution:</strong> Service account keys are a security risk if not managed correctly.
//! See <a href="https://docs.cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys">
//! Best practices for managing service account keys</a> for more information.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use markdown inside the <div>?

Suggested change
//! <div class="warning">
//! <strong>Caution:</strong> Service account keys are a security risk if not managed correctly.
//! See <a href="https://docs.cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys">
//! Best practices for managing service account keys</a> for more information.
//! <div class="warning">
//! **Caution:** Service account keys are a security risk if not managed correctly.
//! See [Best practices for managing service account keys] for more information.

And then add this at the bottom?

/// [Best practices for managing service account keys]: https://docs.cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it doesn't render markdown inside divs

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, interesting, I tried to use the markdown syntax and just assumed was not supported. Will try that trick from the docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, I wonder if there a version of rust that supports that, because I tried this and it is still not rendering:

//! <div class="warning">
//!
//!     **Caution:** Service account keys are a security risk if not managed correctly.
//!     See [Best practices for managing service account keys] for more information.
//!
//! </div>
Screenshot 2026-01-09 at 09 39 53

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To get closer to the rendering at the docs.rs site use:

rustyp update nightly
cargo install --locked cargo-docs-rs
cargo +nightly docs-rs --package google-cloud-storage
Image

But then again, it is not that important.

Comment on lines +50 to +53
//! <div class="warning">
//! <strong>Caution:</strong> Service account keys are a security risk if not managed correctly.
//! See <a href="https://docs.cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys">
//! Best practices for managing service account keys</a> for more information.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To get closer to the rendering at the docs.rs site use:

rustyp update nightly
cargo install --locked cargo-docs-rs
cargo +nightly docs-rs --package google-cloud-storage
Image

But then again, it is not that important.

@alvarowolfx alvarowolfx merged commit c093d3e into googleapis:main Jan 9, 2026
30 checks passed
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