Skip to content

Commit 885affd

Browse files
callmehiphopstephenplusplus
callmehiphop
authored and
stephenplusplus
committed
docs: individual package support (#1479)
docs: refactor doc scripts for modularization
1 parent 2613bcc commit 885affd

46 files changed

Lines changed: 777 additions & 361 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/authentication.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## With `google-cloud`
1+
## Authenticating with this module
22

3-
With `google-cloud` it's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.
3+
It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Google Cloud services.
44

55
```js
66
var config = {

‎docs/faq.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## How do I use `gcloud-node` with Google Compute Engine?
1+
## How do I use this module with Google Compute Engine?
22

33
If you are running this client on Google Compute Engine, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access.
44

@@ -8,7 +8,7 @@ If you are running this client on Google Compute Engine, we handle authenticatio
88
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account, please see our [Authentication][auth-guide] guide.
99

1010

11-
## How do I use `gcloud-node` with AWS Lambda?
11+
## How do I use this module with AWS Lambda?
1212

1313
Our library uses some native libraries, which must be recompiled against the platform running your application. For AWS Lambda, we recommend using [lambda-packager](https://github.com/tomdale/lambda-packager) prior to deploying your code.
1414

@@ -17,7 +17,7 @@ Reference Issues: [#1287](https://github.com/GoogleCloudPlatform/gcloud-node/iss
1717

1818
## Does this replace [Google Cloud Node.js Client][googleapis]?
1919

20-
Google Cloud Node.js Client is a client library for using the broad set of Google APIs. `gcloud-node` is built specifically for the Google Cloud Platform and is the recommended way to integrate Google Cloud APIs into your Node.js applications. If your application requires both Google Cloud Platform and other Google APIs, the 2 libraries may be used together.
20+
Google Cloud Node.js Client is a client library for using the broad set of Google APIs. This module is built specifically for the Google Cloud Platform and is the recommended way to integrate Google Cloud APIs into your Node.js applications. If your application requires both Google Cloud Platform and other Google APIs, the 2 libraries may be used together.
2121

2222
[dev-console]: https://console.developers.google.com/project
2323
[gce-how-to]: https://developers.google.com/compute/docs/authentication#using

‎docs/home.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ <h4 class="latest-release subtle" ng-if="home.latestRelease">
2222
<div class="container">
2323
<ul class="featuring-links">
2424
<li>
25-
<a href="#/docs/{{home.latestRelease.name}}/gcloud" title="gcloud-node docs" class="btn btn-docs">
25+
<a href="#/docs/{{home.module.name}}/{{home.module.version}}/{{home.module.service}}" title="gcloud-node docs" class="btn btn-docs">
2626
<img src="src/images/icon-lang-node-cta.svg" alt="Node.js icon" />
2727
Read the Docs
2828
</a>

docs/json/master/bigquery/.gitkeep renamed to docs/json/bigquery/master/.gitkeep

File renamed without changes.

docs/json/master/bigtable/.gitkeep renamed to docs/json/bigtable/master/.gitkeep

File renamed without changes.

docs/json/master/compute/.gitkeep renamed to docs/json/compute/master/.gitkeep

File renamed without changes.

docs/json/master/datastore/.gitkeep renamed to docs/json/datastore/master/.gitkeep

File renamed without changes.

docs/json/master/dns/.gitkeep renamed to docs/json/dns/master/.gitkeep

File renamed without changes.

docs/json/master/language/.gitkeep renamed to docs/json/google-cloud/master/.gitkeep

File renamed without changes.

docs/json/master/logging/.gitkeep renamed to docs/json/language/master/.gitkeep

File renamed without changes.

0 commit comments

Comments
 (0)