This repository was archived by the owner on Feb 20, 2026. It is now read-only.
docs: Add descriptions to many parameters#1341
Merged
danieljbruce merged 10 commits intomainfrom Oct 25, 2024
Merged
Conversation
product-auto-label
bot
added
size: s
danieljbruce
changed the title
danieljbruce
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
|
Warning: This pull request is touching the following templated files:
|
danieljbruce
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
kevkim-codes
approved these changes
Oct 25, 2024
kevkim-codes
added
automerge
gcf-owl-bot
bot
removed
the
owlbot:run
gcf-merge-on-green
bot
removed
the
automerge
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary:
In the Google Cloud documentation, for many parameters there is no description in the table for parameters. This PR adds descriptions for many of the table cells under parameters that don't have descriptions and corrects others so that descriptions are consistent.
The following is a good example of the problem. The cell for the parameter only contains a type and not a description.
The cells under description for parameters should look like this:
A few broken links are fixed as well. They had to be fixed for the CI check.
Next steps
There are many more cells under the
Descriptioncolumn in the documentation that don't contain a description. These table cells should contain a description so more descriptions need to be added for more parameters.