-
Notifications
You must be signed in to change notification settings - Fork 100
docs(auth): improve signer docs with devsite refs #4201
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
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
| //! <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. |
There was a problem hiding this comment.
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>?
| //! <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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apparently it can happen with some caveats:
https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| //! <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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.

Improvements to Signer docs:
Towards #3645