Repository navigation
docs: add missing product READMEs and fix two doc inaccuracies #10353
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
Open
chiragjangiir
wants to merge
5
commits into
GoogleCloudPlatform:main
Choose a base branch
from
chiragjangiir:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bbc4f1a
docs: add missing product READMEs and fix two doc inaccuracies
chiragjangiir b78f5da
docs: add a short guideline for missing product README contributions
chiragjangiir d470419
docs: fix stray text in CONTRIBUTING missing README guidance
chiragjangiir 9412589
docs: fix Cloud Shell badge to HTTPS and correct CONTRIBUTING.md rela…
chiragjangiir 13151c9
docs: fix the remaining Cloud Shell badge links to HTTPS
chiragjangiir File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # 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> | ||
|
|
||
| Google [BigQuery](https://cloud.google.com/bigquery/) is a serverless data warehouse | ||
| for analytics over massive datasets. These sample Java applications demonstrate how to | ||
| access the BigQuery API using the Google Java client libraries and REST-based samples. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the BigQuery API](https://console.cloud.google.com/flows/enableapi?apiid=bigquery.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Set Environment Variables | ||
|
|
||
| You must set your project ID in order to run the samples. | ||
|
|
||
| ```text | ||
| $ export GOOGLE_CLOUD_PROJECT=<your-project-id-here> | ||
| ``` | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are organized by client library and usage pattern: | ||
|
|
||
| - [Cloud Client samples](cloud-client/) | ||
| - [REST samples](rest/) | ||
| - [BigQuery Storage samples](bigquerystorage/) | ||
|
|
||
| Additional BigQuery-related samples may be located in nested subdirectories. | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # 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> | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
|
|
||
| Google [Bigtable](https://cloud.google.com/bigtable/) is a scalable NoSQL | ||
| wide-column database for large analytical and operational workloads. These sample | ||
| Java applications demonstrate how to access the Bigtable API using the Google Java | ||
| client libraries and related integration patterns. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the Cloud Bigtable API](https://console.cloud.google.com/flows/enableapi?apiid=bigtable.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Set Environment Variables | ||
|
|
||
| You must set your project ID in order to run the samples. | ||
|
|
||
| ```text | ||
| $ export GOOGLE_CLOUD_PROJECT=<your-project-id-here> | ||
| ``` | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are organized by client library, framework, and usage pattern: | ||
|
|
||
| - [Apache Beam samples](beam/) | ||
| - [Spark samples](spark/) | ||
| - [HBase migration samples](hbase/) | ||
| - [Bigtable Proxy samples](bigtable-proxy/) | ||
| - [Scheduled backup samples](scheduled-backups/) | ||
| - [Memorystore samples](memorystore/) | ||
| - [Use case samples](use-cases/) | ||
|
|
||
| Additional samples may be located in nested subdirectories. | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # 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> | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
|
|
||
| [Dialogflow CX](https://cloud.google.com/dialogflow/cx/docs) is a conversational | ||
| AI platform for building advanced virtual agents with flows and pages. These sample | ||
| Java applications demonstrate how to access the Dialogflow CX API using the Google | ||
| Java client libraries. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the Dialogflow CX API](https://console.cloud.google.com/flows/enableapi?apiid=dialogflow.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Set Environment Variables | ||
|
|
||
| You must set your project ID in order to run the samples. | ||
|
|
||
| ```text | ||
| $ export GOOGLE_CLOUD_PROJECT=<your-project-id-here> | ||
| ``` | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples in this directory use the Dialogflow CX Java client library. | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Dialogflow | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=dialogflow/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
|
|
||
| [Dialogflow](https://cloud.google.com/dialogflow/) helps you build conversational | ||
| interfaces for websites, mobile applications, and other platforms. These sample | ||
| Java applications demonstrate how to access the Dialogflow API using the Google | ||
| Java client libraries. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the Dialogflow API](https://console.cloud.google.com/flows/enableapi?apiid=dialogflow.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are organized by usage pattern: | ||
|
|
||
| - [Snippet samples](snippets/) | ||
| - [Basic webhook samples](basic-webhook/) | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Cloud Firestore | ||
|
|
||
| <a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=firestore/README.md"> | ||
| <img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a> | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
|
|
||
| [Cloud Firestore](https://cloud.google.com/firestore/) is a flexible, scalable | ||
| NoSQL document database for mobile, web, and server development. These sample | ||
| Java applications demonstrate how to access the Firestore API using the Google | ||
| Java client libraries. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the Cloud Firestore API](https://console.cloud.google.com/flows/enableapi?apiid=firestore.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Set Environment Variables | ||
|
|
||
| You must set your project ID in order to run the samples. | ||
|
|
||
| ```text | ||
| $ export GOOGLE_CLOUD_PROJECT=<your-project-id-here> | ||
| ``` | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are organized in the [samples](samples/) subdirectory. | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # 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> | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
|
|
||
| Google [Cloud Pub/Sub](https://cloud.google.com/pubsub/) is a messaging and | ||
| event-streaming service for asynchronous communication between independent | ||
| applications. These sample Java applications demonstrate how to access the | ||
| Pub/Sub API using the Google Java client libraries and related integration patterns. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the Cloud Pub/Sub API](https://console.cloud.google.com/flows/enableapi?apiid=pubsub.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are organized by client library and integration pattern: | ||
|
|
||
| - [Cloud Client samples](cloud-client/) | ||
| - [Spring integration samples](spring/) | ||
| - [Streaming analytics samples](streaming-analytics/) | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # 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> | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
|
|
||
| Google [Cloud Storage](https://cloud.google.com/storage/) is unified object storage | ||
| for developers and enterprises, from live data serving to data analytics and archival. | ||
| These sample Java applications demonstrate how to access the Cloud Storage API using | ||
| the Google Cloud Java client libraries and related SDK samples. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| ### Enable the API | ||
|
|
||
| You must [enable the Cloud Storage API](https://console.cloud.google.com/flows/enableapi?apiid=storage.googleapis.com) | ||
| for your project in order to use these samples. | ||
|
|
||
| ### Set Environment Variables | ||
|
|
||
| You must set your project ID in order to run the samples. | ||
|
|
||
| ```text | ||
| $ export GOOGLE_CLOUD_PROJECT=<your-project-id-here> | ||
| ``` | ||
|
|
||
| ### Authentication | ||
|
|
||
| See the [authentication documentation](https://cloud.google.com/docs/authentication/production) | ||
| for more information about authenticating for Google Cloud APIs. | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are organized by client library and SDK usage: | ||
|
|
||
| - [Cloud Client samples](cloud-client/) | ||
| - [AWS S3 compatibility SDK samples](s3-sdk/) | ||
|
|
||
| ## Tests | ||
|
|
||
| Run all tests in a sample directory with Maven: | ||
|
|
||
| ``` | ||
| mvn clean verify | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [contributor guide](../../CONTRIBUTING.md) for this repository. | ||
|
chiragjangiir marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.