Skip to content

Commit 64b43df

Browse files
callmehiphopstephenplusplus
authored andcommitted
docs: individual package support (googleapis#1479)
docs: refactor doc scripts for modularization
1 parent 1fe69b3 commit 64b43df

File tree

45 files changed

+777
-156
lines changed

Some content is hidden

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

45 files changed

+777
-156
lines changed

docs/authentication.md

+2-2
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

+3-3
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

+1-1
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>
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/json/vision/master/.gitkeep

Whitespace-only changes.

docs/manifest.json

+117-45
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,125 @@
22
"lang": "node",
33
"friendlyLang": "Node.js",
44
"markdown": "javascript",
5-
"versions": [
6-
"v0.37.0",
7-
"v0.36.0",
8-
"v0.35.0",
9-
"v0.34.0",
10-
"v0.33.0",
11-
"v0.32.0",
12-
"v0.31.0",
13-
"v0.30.3",
14-
"v0.30.2",
15-
"v0.30.1",
16-
"v0.30.0",
17-
"v0.29.0",
18-
"v0.28.0",
19-
"v0.27.0",
20-
"v0.26.0",
21-
"v0.25.1",
22-
"v0.25.0",
23-
"v0.24.1",
24-
"v0.24.0",
25-
"v0.23.0",
26-
"v0.22.0",
27-
"v0.21.0",
28-
"v0.20.0",
29-
"v0.19.1",
30-
"v0.19.0",
31-
"v0.18.0",
32-
"v0.17.0",
33-
"v0.16.0",
34-
"v0.15.0",
35-
"v0.14.0",
36-
"v0.13.2",
37-
"v0.13.1",
38-
"v0.12.0",
39-
"v0.11.0",
40-
"v0.10.0",
41-
"v0.9.0",
42-
"v0.8.1",
43-
"v0.8.0",
44-
"v0.7.1",
45-
"v0.7.0",
46-
"v0.6.0",
47-
"v0.5.0",
48-
"master"
49-
],
505
"content": "json",
516
"home": "home.html",
7+
"titleDelimiter": " » ",
8+
"defaultModule": "google-cloud",
9+
"modules": [
10+
{
11+
"id": "google-cloud",
12+
"name": "google-cloud",
13+
"defaultService": "google-cloud",
14+
"versions": [
15+
"master"
16+
]
17+
},
18+
{
19+
"id": "bigquery",
20+
"name": "@google-cloud/bigquery",
21+
"defaultService": "bigquery",
22+
"versions": [
23+
"master"
24+
]
25+
},
26+
{
27+
"id": "bigtable",
28+
"name": "@google-cloud/bigtable",
29+
"defaultService": "bigtable",
30+
"versions": [
31+
"v0.1.0",
32+
"master"
33+
]
34+
},
35+
{
36+
"id": "compute",
37+
"name": "@google-cloud/compute",
38+
"defaultService": "compute",
39+
"versions": [
40+
"master"
41+
]
42+
},
43+
{
44+
"id": "datastore",
45+
"name": "@google-cloud/datastore",
46+
"defaultService": "datastore",
47+
"versions": [
48+
"master"
49+
]
50+
},
51+
{
52+
"id": "dns",
53+
"name": "@google-cloud/dns",
54+
"defaultService": "dns",
55+
"versions": [
56+
"master"
57+
]
58+
},
59+
{
60+
"id": "language",
61+
"name": "@google-cloud/language",
62+
"defaultService": "language",
63+
"versions": [
64+
"master"
65+
]
66+
},
67+
{
68+
"id": "logging",
69+
"name": "@google-cloud/logging",
70+
"defaultService": "logging",
71+
"versions": [
72+
"master"
73+
]
74+
},
75+
{
76+
"id": "prediction",
77+
"name": "@google-cloud/prediction",
78+
"defaultService": "prediction",
79+
"versions": [
80+
"master"
81+
]
82+
},
83+
{
84+
"id": "pubsub",
85+
"name": "@google-cloud/pubsub",
86+
"defaultService": "pubsub",
87+
"versions": [
88+
"master"
89+
]
90+
},
91+
{
92+
"id": "resource",
93+
"name": "@google-cloud/resource",
94+
"defaultService": "resource",
95+
"versions": [
96+
"master"
97+
]
98+
},
99+
{
100+
"id": "storage",
101+
"name": "@google-cloud/storage",
102+
"defaultService": "storage",
103+
"versions": [
104+
"master"
105+
]
106+
},
107+
{
108+
"id": "translate",
109+
"name": "@google-cloud/translate",
110+
"defaultService": "translate",
111+
"versions": [
112+
"master"
113+
]
114+
},
115+
{
116+
"id": "vision",
117+
"name": "@google-cloud/vision",
118+
"defaultService": "vision",
119+
"versions": [
120+
"master"
121+
]
122+
}
123+
],
52124
"package": {
53125
"title": "npm",
54126
"href": "https://www.npmjs.com/package/gcloud"

docs/overview.html

-23
This file was deleted.

package.json

+5-1
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,14 @@
1010
"istanbul": "^0.3.5",
1111
"jscs": "^2.1.1",
1212
"jshint": "^2.9.1",
13+
"lodash.template": "^4.3.0",
1314
"mitm": "^1.1.0",
15+
"mkdirp": "^0.5.1",
1416
"mocha": "^3.0.1",
1517
"propprop": "^0.3.0",
1618
"proxyquire": "^1.7.10",
1719
"request": "^2.70.0",
20+
"semver": "^5.3.0",
1821
"shelljs": "^0.7.3",
1922
"string-format-obj": "^1.0.0",
2023
"through2": "^2.0.0"
@@ -23,7 +26,8 @@
2326
"link-modules": "node ./scripts/link.js",
2427
"install-module-dependencies": "node ./scripts/install.js",
2528
"postinstall": "npm run link-modules && npm run install-module-dependencies",
26-
"docs": "node ./scripts/docs.js",
29+
"docs": "node ./scripts/docs/packages.js",
30+
"bundle": "node ./scripts/docs/bundle.js",
2731
"lint": "jshint scripts/ packages/ system-test/ test/ && jscs packages/ system-test/ test/",
2832
"test": "npm run docs && mocha test/docs.js packages/*/test/*.js",
2933
"system-test": "mocha packages/*/system-test/*.js --no-timeouts --bail",

packages/bigquery/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"proxyquire": "^1.7.10"
6969
},
7070
"scripts": {
71-
"publish": "node ../../scripts/publish.js",
71+
"publish": "node ../../scripts/publish.js bigquery",
7272
"test": "mocha test/*.js",
7373
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7474
},

packages/bigtable/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
"sinon": "^1.17.4"
7575
},
7676
"scripts": {
77-
"publish": "node ../../scripts/publish.js",
77+
"publish": "node ../../scripts/publish.js bigtable",
7878
"test": "mocha test/*.js",
7979
"system-test": "mocha system-test/*.js --no-timeouts --bail"
8080
},

packages/common/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"sinon": "^1.17.4"
6767
},
6868
"scripts": {
69-
"publish": "node ../../scripts/publish.js",
69+
"publish": "node ../../scripts/publish.js common",
7070
"test": "mocha test/*.js"
7171
},
7272
"license": "Apache-2.0",

packages/compute/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
"proxyquire": "^1.7.10"
6868
},
6969
"scripts": {
70-
"publish": "node ../../scripts/publish.js",
70+
"publish": "node ../../scripts/publish.js compute",
7171
"test": "mocha test/*.js",
7272
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7373
},

packages/datastore/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
"through2": "^2.0.0"
7171
},
7272
"scripts": {
73-
"publish": "node ../../scripts/publish.js",
73+
"publish": "node ../../scripts/publish.js datastore",
7474
"test": "mocha test/*.js",
7575
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7676
},

packages/dns/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"tmp": "0.0.27"
6767
},
6868
"scripts": {
69-
"publish": "../../scripts/publish",
69+
"publish": "../../scripts/publish dns",
7070
"test": "mocha test/*.js",
7171
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7272
},

packages/google-cloud/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
"proxyquire": "^1.7.10"
113113
},
114114
"scripts": {
115-
"publish": "node ../../scripts/publish.js",
115+
"publish": "node ../../scripts/publish.js google-cloud",
116116
"test": "mocha test/*.js",
117117
"system-test": "mocha system-test/*.js --no-timeouts --bail"
118118
},

packages/language/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
"proxyquire": "^1.7.10"
6767
},
6868
"scripts": {
69-
"publish": "../../scripts/publish.sh",
69+
"publish": "../../scripts/publish.js language",
7070
"test": "mocha test/*.js",
7171
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7272
},

packages/logging/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
"proxyquire": "^1.7.10"
7070
},
7171
"scripts": {
72-
"publish": "node ../../scripts/publish.js",
72+
"publish": "node ../../scripts/publish.js logging",
7373
"test": "mocha test/*.js",
7474
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7575
},

packages/prediction/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
"proxyquire": "^1.7.10"
7070
},
7171
"scripts": {
72-
"publish": "node ../../scripts/publish.js",
72+
"publish": "node ../../scripts/publish.js prediction",
7373
"test": "mocha test/*.js",
7474
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7575
},

packages/pubsub/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
"proxyquire": "^1.7.10"
6565
},
6666
"scripts": {
67-
"publish": "node ../../scripts/publish.js",
67+
"publish": "node ../../scripts/publish.js pubsub",
6868
"test": "mocha test/*.js",
6969
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7070
},

packages/resource/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
"proxyquire": "^1.7.10"
6262
},
6363
"scripts": {
64-
"publish": "node ../../scripts/publish.js",
64+
"publish": "node ../../scripts/publish.js resource",
6565
"test": "mocha test/*.js",
6666
"system-test": "mocha system-test/*.js --no-timeouts --bail"
6767
},

packages/storage/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
"tmp": "0.0.27"
7979
},
8080
"scripts": {
81-
"publish": "node ../../scripts/publish.js",
81+
"publish": "node ../../scripts/publish.js storage",
8282
"test": "mocha test/*.js",
8383
"system-test": "mocha system-test/*.js --no-timeouts --bail"
8484
},

packages/translate/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
"proxyquire": "^1.7.10"
6262
},
6363
"scripts": {
64-
"publish": "node ../../scripts/publish.js",
64+
"publish": "node ../../scripts/publish.js translate",
6565
"test": "mocha test/*.js",
6666
"system-test": "mocha system-test/*.js --no-timeouts --bail"
6767
},

packages/vision/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
"tmp": "0.0.27"
7272
},
7373
"scripts": {
74-
"publish": "node ../../scripts/publish.js",
74+
"publish": "node ../../scripts/publish.js vision",
7575
"test": "mocha test/*.js",
7676
"system-test": "mocha system-test/*.js --no-timeouts --bail"
7777
},

0 commit comments

Comments
 (0)