Skip to content

Commit c5a1b21

Browse files
bshafferbshaffer
authored
updates all product READMEs with links to the PHP sample docs (GoogleCloudPlatform#919)
1 parent 7d41d99 commit c5a1b21

File tree

23 files changed

+88
-38
lines changed

23 files changed

+88
-38
lines changed

‎bigquery/api/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Description
44

5-
All code in the `snippets` directory demonstrate how to invoke Google BigQuery from PHP.
5+
All code in the `snippets` directory demonstrate how to invoke
6+
[Google BigQuery][bigquery] from PHP.
7+
8+
[bigquery]: https://cloud.google.com/bigquery/docs/quickstarts/quickstart-client-libraries
69

710
## Build and Run
811
1. **Enable APIs** - [Enable the BigQuery API](https://console.cloud.google.com/flows/enableapi?apiid=bigquery)

‎bigtable/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22

33
## Description
44

5+
These samples show how to use the
6+
[Cloud Bigtable API][bigtable] from PHP.
7+
58
All code in the `src` directory demonstrates how to connect to Cloud Bigtable and run some basic operations to create instance, create cluster, delete instance and delete cluster.
69

10+
[bigtable]: https://cloud.google.com/bigtable/docs/reference/libraries
11+
712
## Build and Run
813
1. **Enable APIs** - [Enable the Bigtable API](https://console.cloud.google.com/flows/enableapi?apiid=bigtable)
914
and create a new project or select an existing project.

‎datastore/api/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Cloud Datastore code snippets
22

3-
This code samples are intended to be in the following document:
4-
https://cloud.google.com/datastore/docs/
3+
These samples show how to use the [Datastore API][datastore]
4+
from PHP.
5+
6+
[datastore]: https://cloud.google.com/datastore/docs/reference/libraries
57

68
The code is using
79
[Google Cloud Client Library for PHP](https://googlecloudplatform.github.io/google-cloud-php/#/).

‎debugger/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
## Description
44

55
This simple [Silex][silex] application demonstrates how to
6-
install and run the Stackdriver Debugger Agent for PHP.
6+
install and run the [Stackdriver Debugger Agent][debugger] for PHP.
7+
8+
[debugger]: https://cloud.google.com/debugger/docs/setup/php
79

810
## Build and Run
911

‎dialogflow/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This command-line application demonstrates how to invoke Dialogflow
1111
API from PHP.
1212

1313
## Before you begin
14-
1. Follow the first 2 steps of [this quickstart](https://cloud.google.com/dialogflow-enterprise/docs/quickstart).
14+
1. Follow the first 2 steps of [this quickstart](https://cloud.google.com/dialogflow-enterprise/docs/quickstart-api).
1515
Feel free to stop after you've created an agent.
1616

1717
2. This sample comes with a [sample agent](https://github.com/GoogleCloudPlatform/php-docs-samples/blob/master/dialogflow/resources/RoomReservation.zip) which you can use to try the samples with. Follow the instructions on [this page](https://dialogflow.com/docs/best-practices/import-export-for-versions) to import the agent from the [console](https://console.dialogflow.com/api-client).

‎dlp/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77

88
## Description
99

10-
This simple command-line application demonstrates how to invoke Google
11-
DLP API from PHP.
10+
This simple command-line application demonstrates how to invoke
11+
[Google DLP API][dlp-api] from PHP.
12+
13+
[dlp-api]: https://cloud.google.com/dlp/docs/libraries
1214

1315
## Build and Run
1416
1. **Enable APIs** - [Enable the DLP API](

‎error_reporting/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,15 @@
55
[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
66
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=error_reporting
77

8-
`quickstart.php` and `error_reporting.php` are simple command-line programs to demonstrate logging
9-
exceptions, errors, and PHP fatral errors to Stackdriver Error Reporting.
8+
9+
This directory contains samples for setting up and using
10+
[Stackdriver Error Reporting][error-reporting] for PHP.
11+
12+
[error-reporting]: https://cloud.google.com/error-reporting/docs/setup/php
13+
14+
`quickstart.php` and `src/report_error.php` are simple command-line programs to
15+
demonstrate logging exceptions, errors, and PHP fatral errors to
16+
Stackdriver Error Reporting.
1017

1118
# Installation
1219

‎firestore/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
These samples show how to use the [Google Cloud Firestore API][cloud-firestore-api] to store and query data.
44

5-
[cloud-firestore-api]: http://cloud.google.com/cloud-firestore
5+
[cloud-firestore-api]: https://cloud.google.com/firestore/docs/quickstart-servers
66

77
## Setup
88

‎jobs/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
## Description
44

5-
These samples show how to use the [Google Cloud Job Discovery API]
6-
(https://cloud.google.com/job-discovery/).
5+
These samples show how to use the [Google Cloud Job Discovery API][job-discovery]
6+
from PHP.
7+
8+
[job-discovery]: https://cloud.google.com/talent-solution/job-search/v2/docs/libraries
79

810
## Build and Run
911
1. **Enable APIs** - [Enable the Job Discovery API](https://console.cloud.google.com/flows/enableapi?apiid=jobs.googleapis.com)

‎kms/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77

88
## Description
99

10-
These samples show how to use the [Google Cloud KMS API](https://cloud.google.com/kms/).
10+
These samples show how to use the
11+
[Google Cloud KMS API](https://cloud.google.com/kms/docs/reference/libraries) from PHP.
1112

1213
## Build and Run
1314
1. **Enable APIs** - [Enable the KMS API](https://console.cloud.google.com/flows/enableapi?apiid=cloudkms.googleapis.com)

‎language/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=language
77

88
These samples show how to use the [Google Cloud Natural Language API][language-api]
9-
to analyze text.
9+
from PHP to analyze text.
1010

11-
[language-api]: http://cloud.google.com/natural-language
11+
[language-api]: https://cloud.google.com/natural-language/docs/quickstart-client-libraries
1212
[google-cloud-php]: https://googlecloudplatform.github.io/google-cloud-php/
1313

1414
## Setup

‎logging/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
66
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=logging
77

8+
This directory contains samples for calling [Stackdriver Logging][logging]
9+
from PHP.
10+
811
`logging.php` is a simple command-line program to demonstrate writing to a log,
912
listing its entries, deleting it, interacting with sinks to export logs to
1013
Google Cloud Storage.
@@ -30,3 +33,5 @@ Run the samples:
3033
php logging.php list # For getting sub command list
3134
php logging.php help write # For showing help for write sub command `write`
3235
```
36+
37+
[logging]: https://cloud.google.com/logging/docs/reference/libraries

‎monitoring/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ Stackdriver Monitoring PHP Samples
66
[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
77
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=monitoring
88

9-
This directory contains samples for Stackdriver Monitoring.
10-
[Stackdriver Monitoring][monitoring] collects metrics, events, and metadata from
9+
This directory contains samples for calling [Stackdriver Monitoring][monitoring]
10+
from PHP.
11+
12+
Stackdriver Monitoring collects metrics, events, and metadata from
1113
Google Cloud Platform, Amazon Web Services (AWS), hosted uptime probes,
1214
application instrumentation, and a variety of common application components
1315
including Cassandra, Nginx, Apache Web Server, Elasticsearch and many others.
1416

15-
[monitoring]: https://cloud.google.com/monitoring/docs
17+
[monitoring]: https://cloud.google.com/monitoring/docs/reference/libraries
1618

1719
## Setup
1820

‎pubsub/api/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
## Description
44

5-
This simple command-line application demonstrates how to invoke Google Pub\Sub from PHP.
5+
This simple command-line application demonstrates how to invoke
6+
[Google Pub\Sub][pubsub] from PHP.
7+
8+
[pubsub]: https://cloud.google.com/pubsub/docs/quickstart-client-libraries
69

710
## Build and Run
811
1. **Enable APIs** - [Enable the Pub\Sub API](https://console.cloud.google.com/flows/enableapi?apiid=pubsub)

‎spanner/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,18 @@ Google Cloud Spanner PHP Samples
66
[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
77
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=spanner
88

9-
This directory contains samples for Google Cloud Spanner.
10-
[Google Cloud Spanner][spanner] is a highly scalable, transactional, managed,
9+
This directory contains samples for calling [Google Cloud Spanner][spanner]
10+
from PHP.
11+
12+
Google Cloud Spanner is a highly scalable, transactional, managed,
1113
[NewSQL][newsql] database service. Cloud Spanner solves the need for a
1214
horizontally-scaling database with consistent global transactions and SQL
1315
semantics.
1416

1517
See [Getting Started in PHP][getting-started-php]
1618
for a walkthrough of these samples.
1719

18-
[spanner]: https://cloud.google.com/spanner/docs
20+
[spanner]: https://cloud.google.com/spanner/docs/reference/libraries
1921
[newsql]: https://en.wikipedia.org/wiki/NewSQL
2022
[getting-started-php]: https://cloud.google.com/spanner/docs/getting-started/php/
2123

‎speech/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ If you have not set a timezone you may get an error from php. This can be resolv
6363
1. Editing the php.ini file (or creating one if it doesn't exist)
6464
1. Adding the timezone to the php.ini file e.g., adding the following line: date.timezone = "America/Los_Angeles"
6565

66-
[speech-api]: http://cloud.google.com/speech
66+
[speech-api]: https://cloud.google.com/speech-to-text/docs/quickstart-client-libraries
6767
[google-cloud-php]: https://googlecloudplatform.github.io/google-cloud-php/
68-
[choose-encoding]: https://cloud.google.com/speech/docs/best-practices#choosing_an_audio_encoding
68+
[choose-encoding]: https://cloud.google.com/speech-to-text/docs/best-practices#choosing_an_audio_encoding
6969
[sox]: http://sox.sourceforge.net/
7070
[grpc]: http://grpc.io
7171
[adc]: https://developers.google.com/identity/protocols/application-default-credentials

‎storage/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77

88
## Description
99

10-
This simple command-line application demonstrates how to invoke Google Cloud Storage from PHP.
10+
This simple command-line application demonstrates how to invoke
11+
[Google Cloud Storage][gcs-api] from PHP.
12+
13+
[gcs-api]: https://cloud.google.com/storage/docs/reference/libraries
1114

1215
## Licensing
1316

‎tasks/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
## Description
44

5-
Al code in the snippets directory demonstrate how to invoke Cloud Tasks from PHP.
5+
Al code in the snippets directory demonstrate how to invoke
6+
[Cloud Tasks][cloud-tasks] from PHP.
67

78
`src/create_http_task.php` is a simple function to create tasks with an HTTP target.
89

10+
[cloud-tasks]: https://cloud.google.com/tasks/docs/quickstart-appengine
11+
912
## Setup:
1013

1114
1. **Enable APIs** - [Enable the Cloud Tasks API](https://console.cloud.google.com/flows/enableapi?apiid=cloudtasks)
@@ -41,7 +44,7 @@ Al code in the snippets directory demonstrate how to invoke Cloud Tasks from PHP
4144
* `PROJECT_ID` is your Google Cloud Project id.
4245
* `QUEUE_ID` is your queue id.
4346
Queue IDs already created can be listed with `gcloud alpha tasks queues list`.
44-
* `LOCATION_ID` is the location of your queue.
47+
* `LOCATION_ID` is the location of your queue.
4548
Determine the location ID, which can be discovered with
4649
`gcloud tasks queues describe <QUEUE_NAME>`, with the location embedded in
4750
the "name" value (for instance, if the name is

‎texttospeech/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77

88
## Description
99

10-
These command-line samples demonstrates how to invoke Cloud Text-to-Speech
11-
API from PHP.
10+
These command-line samples demonstrates how to invoke
11+
[Cloud Text-to-Speech API][tts-api] from PHP.
12+
13+
[tts-api]: https://cloud.google.com/text-to-speech/docs/quickstart-client-libraries
1214

1315
## Setup
1416

‎trace/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The sample code and the test for Stackdriver Trace documentation
1+
# Google Cloud Trace Samples
22

3-
This directory holds the sample code and the test for the following page:
4-
https://cloud.google.com/trace/docs/setup/php
3+
This directory holds the sample code and the test for the
4+
[Stackdriver Trace documentation](https://cloud.google.com/trace/docs/setup/php).

‎translate/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77

88
## Description
99

10-
These samples show how to use the [Google Cloud Translate API](
11-
https://cloud.google.com/translate/).
10+
These samples show how to use the [Google Cloud Translate API][translate-api]
11+
from PHP.
12+
13+
[translate-api]: https://cloud.google.com/translate/docs/quickstart-client-libraries
1214

1315
## Build and Run
1416
1. **Enable APIs** - [Enable the Translate API](https://console.cloud.google.com/flows/enableapi?apiid=translate)

‎video/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77

88
## Description
99

10-
This simple command-line application demonstrates how to invoke Google
11-
Video Intelligence API from PHP.
10+
This simple command-line application demonstrates how to invoke
11+
[Google Video Intelligence API][video-api] from PHP.
12+
13+
[video-api]: https://cloud.google.com/video-intelligence/docs/quickstart-client-libraries
1214

1315
## Build and Run
1416
1. **Enable APIs** - [Enable the Video Intelligence API](

‎vision/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77

88
## Description
99

10-
This simple command-line application demonstrates how to invoke Google
11-
Vision API from PHP.
10+
This simple command-line application demonstrates how to invoke
11+
[Google Vision API][vision-api] from PHP.
12+
13+
[vision-api]: https://cloud.google.com/vision/docs/quickstart-client-libraries
1214

1315
## Build and Run
1416
1. **Enable APIs** - [Enable the Vision API](https://console.cloud.google.com/flows/enableapi?apiid=vision.googleapis.com)

0 commit comments

Comments
 (0)