Create documentation for Google Cloud Parameter Manager#1835
Create documentation for Google Cloud Parameter Manager#1835jcwriter74 wants to merge 2 commits into
Conversation
Added documentation for Google Cloud Parameter Manager integration, including usage examples and prerequisites.
✅ Deploy Preview for adk-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Updated markdown formatting for better readability and consistency.
| @@ -0,0 +1,84 @@ | |||
|
|
|||
| # Catalog Frontmatter | |||
|
|
||
| # Catalog Frontmatter | ||
|
|
||
| |element|content| |
There was a problem hiding this comment.
This front matter content is in the wrong format. see correct format example here:
https://github.com/google/adk-docs/blob/main/CONTRIBUTING.md#integrations
| --- | ||
|
|
||
| # Google Cloud Secrets Manager | ||
| ## Google Cloud Parameter Manager |
There was a problem hiding this comment.
do not not stack headings: heading should always have paragraphs after them.
| ## With different authentication credentials | ||
|
|
||
| ### Using default credentials | ||
| ```client = ParameterManagerClient()``` | ||
|
|
||
| ### Or with a service account json string | ||
| ```client = ParameterManagerClient(service_account_json="...")``` | ||
|
|
||
| ### Or with an auth token | ||
| ```client = ParameterManagerClient(auth_token="...")``` | ||
|
|
||
| ### To use a regional Parameter Manager endpoint, pass location: | ||
|
|
||
| ```client = ParameterManagerClient(location="us-central1")``` |
There was a problem hiding this comment.
Don't use headings to list examples or items. use a list format
|
|
||
| # Prerequisites | ||
|
|
||
| ### Only the class ParameterManagerClient |
There was a problem hiding this comment.
Don't use headings to list items. use a list format
There was a problem hiding this comment.
do NOT use spaces in file names. Use git mv and rename this file to:
parameter-manager.md
| ## Complete usage of ParameterManagerClient | ||
| Here is a complete example of how to initialize the client and use it to fetch a parameter within an ADK application. | ||
|
|
||
| ==python== |
| ```client = ParameterManagerClient(location="us-central1")``` | ||
|
|
||
| # Prerequisites | ||
|
|
There was a problem hiding this comment.
include an introductory sentence, at the minimum
|
|
||
| # Google Cloud Secrets Manager | ||
| ## Google Cloud Parameter Manager | ||
| The Parameter Manager integration is an extension of the Secret Manager class, offering a lightweight client designed to fetch processed parameter data from Google Cloud. This tool is ideal for agents that require configuration settings to be handled independently of the agent’s internal process. If you want to know more about all options, features or capabilities that this integration facilitates, click here. |
There was a problem hiding this comment.
This tool is ideal for agents --> This tool is useful for agents
avoid superlative language in developer documentation
... click here.
Revise this sentence. do not use language like "click here" in documentation or as the text of links
https://developers.google.com/style/cross-references#vague-link-text
| from google.adk.integrations.parameter_manager.parameter_client import ParameterManagerClient | ||
|
|
||
| def fetch_external_api_key(): | ||
| -- 1. Initialize the Client |
There was a problem hiding this comment.
this is not the correct format for Python comment. As written this code will not compile. update all the comments in this code.
2 participants
Added documentation for Google Cloud Parameter Manager integration, including usage examples and prerequisites.
New docs: https://github.com/google/adk-docs/pull/1835/changes#diff-6bc7ccb3f76a40c4885b078be3007c47cd48f65742157066e744ad51ca17d276
Previous docs: https://github.com/google/adk-docs/pull/1653/changes#diff-7e3ffa2bbabe50e3016cdf308f52d373471ce50c069404f756603e4d71a150ef