Repository navigation
docs: add missing product READMEs and fix two doc inaccuracies - #10353
chiragjangiir wants to merge 4 commits into
Conversation
Add top-level READMEs for product directories that had real samples but no product-level README: bigquery, pubsub, storage, bigtable, dialogflow, dialogflow-cx, and firestore. Use the existing repo README shape from secretmanager/README.md so the new docs match current conventions. Also fix two doc inaccuracies: - run/README.md had a Cloud Shell link pointing at blog/README.md - auth/README.md used com.example.storage.ClassName in the quickstart exec example instead of an auth-appropriate class name This is a docs-only change.
Add a small documentation-only guideline to CONTRIBUTING.md for contributions that add missing product-level READMEs. This helps keep future contributions consistent and avoids inventing sample entrypoints, class names, or product claims that the folder contents do not support. This is a docs-only change.
Remove an accidental non-English word from the documentation-only contribution guidance and keep the wording clean. This is a docs-only change.
product-auto-label
Bot
added
samples
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds guidelines for documentation-only contributions to CONTRIBUTING.md, updates execution commands and links in existing READMEs, and introduces new README.md files for several Google Cloud products (BigQuery, Bigtable, Dialogflow, Dialogflow CX, Firestore, Pub/Sub, and Storage). The feedback recommends using HTTPS instead of HTTP for the Cloud Shell badge image URLs in the new READMEs and correcting the relative paths to CONTRIBUTING.md from ../../ to ../ since these directories are located at the root level.
| # Google BigQuery | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=bigquery/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> |
There was a problem hiding this comment.
Use HTTPS instead of HTTP for the image source URL to ensure secure transport, and remove the extra space before the equals sign.
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | |
| <img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a> |
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. |
There was a problem hiding this comment.
The bigquery directory is a top-level directory, so the relative path to CONTRIBUTING.md should be ../CONTRIBUTING.md instead of ../../CONTRIBUTING.md.
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | |
| See the [contributor guide](../CONTRIBUTING.md) for this repository. |
| # Google Cloud Bigtable | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=bigtable/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> |
There was a problem hiding this comment.
Use HTTPS instead of HTTP for the image source URL to ensure secure transport, and remove the extra space before the equals sign.
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | |
| <img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a> |
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. |
There was a problem hiding this comment.
The bigtable directory is a top-level directory, so the relative path to CONTRIBUTING.md should be ../CONTRIBUTING.md instead of ../../CONTRIBUTING.md.
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | |
| See the [contributor guide](../CONTRIBUTING.md) for this repository. |
| # Dialogflow CX | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=dialogflow-cx/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> |
There was a problem hiding this comment.
Use HTTPS instead of HTTP for the image source URL to ensure secure transport, and remove the extra space before the equals sign.
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | |
| <img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a> |
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. |
There was a problem hiding this comment.
The firestore directory is a top-level directory, so the relative path to CONTRIBUTING.md should be ../CONTRIBUTING.md instead of ../../CONTRIBUTING.md.
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | |
| See the [contributor guide](../CONTRIBUTING.md) for this repository. |
| # Google Cloud Pub/Sub | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=pubsub/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> |
There was a problem hiding this comment.
Use HTTPS instead of HTTP for the image source URL to ensure secure transport, and remove the extra space before the equals sign.
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | |
| <img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a> |
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. |
There was a problem hiding this comment.
The pubsub directory is a top-level directory, so the relative path to CONTRIBUTING.md should be ../CONTRIBUTING.md instead of ../../CONTRIBUTING.md.
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | |
| See the [contributor guide](../CONTRIBUTING.md) for this repository. |
| # Google Cloud Storage | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=storage/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> |
There was a problem hiding this comment.
Use HTTPS instead of HTTP for the image source URL to ensure secure transport, and remove the extra space before the equals sign.
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | |
| <img alt="Open in Cloud Shell" src="https://gstatic.com/cloudssh/images/open-btn.png"></a> |
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. |
There was a problem hiding this comment.
The storage directory is a top-level directory, so the relative path to CONTRIBUTING.md should be ../CONTRIBUTING.md instead of ../../CONTRIBUTING.md.
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | |
| See the [contributor guide](../CONTRIBUTING.md) for this repository. |
Review feedback statusThe suggestions from the automated review are now addressed in commit
Files changed:
The two doc fixes from the original PR are unchanged:
If the review comments still appear against the old patch, that is because they were issued before this fix landed. The current Files changed tab shows the corrected versions. |
…tive path - Use https:// for the Cloud Shell badge image across all new product READMEs - Fix CONTRIBUTING.md relative path from ../../ to ../ (all are top-level dirs)
|
Quick pointer for reviewers: the earlier review suggestions are now reflected in the current diff.
The corrected versions are visible on the Files changed tab: The two original doc fixes are unchanged:
Checks are green on the latest commit. |
2 participants
Summary
This PR adds top-level product READMEs for Java sample directories that already contain samples but had no product-level README:
bigquery/pubsub/storage/bigtable/dialogflow/dialogflow-cx/firestore/The new READMEs follow the existing repo pattern from
secretmanager/README.md: a Cloud Shell badge, a short product description, API enablement guidance, and a pointer to where the samples live in each folder.This PR also fixes two small doc inaccuracies:
run/README.mdhad a Cloud Shell link pointing atblog/README.mdauth/README.mdusedcom.example.storage.ClassNamein the quickstart exec example instead of an auth-appropriate class nameWhy
A product-level README helps readers find the samples and understand basic setup without opening every subdirectory. The two fixes remove confusing or incorrect links and examples in existing docs.
Scope
Test plan
run/README.mdandauth/README.mdchanges are correct.🤖 Generated with Codebuff
Co-Authored-By: Codebuff noreply@codebuff.com