Skip to content

Commit 948208f

Browse files
Merge pull request #326 from stephenplusplus/spp--docs-in-repo
Expand scope of gh-pages site to include non-API docs
2 parents cde8c45 + aeb59b9 commit 948208f

39 files changed

+473
-237
lines changed

docs/components/docs/docs.html

-209
This file was deleted.

docs/faq.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## How do I use `gcloud` with Google Compute Engine?
2+
3+
If you are running this client on Google Compute Engine, we handle authorization 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.
4+
5+
## I'm not using Compute Engine. What do I need to do?
6+
7+
If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account:
8+
9+
1. Visit the [Google Developers Console][dev-console].
10+
2. Create a new project or click on an existing project.
11+
3. Navigate to **APIs & auth** > **APIs section** and turn on the following APIs (you may need to enable billing in order to use these services):
12+
* Google Cloud Datastore API
13+
* Google Cloud Storage
14+
* Google Cloud Storage JSON API
15+
4. Navigate to **APIs & auth** > **Credentials** and then:
16+
* If you want to use a new service account, click on **Create new Client ID** and select **Service account**. After the account is created, you will be prompted to download the JSON key file that the library uses to authorize your requests.
17+
* If you want to generate a new key for an existing service account, click on **Generate new JSON key** and download the JSON key file.
18+
19+
## What is the relationship between this and the `gcloud` command-line tool?
20+
21+
Both this library and the `gcloud` command-line tool are a part of the Google Cloud SDK: a collection of tools and libraries that enable you to easily create and manage resources on the Google Cloud Platform. The `gcloud` command-line tool can be used to manage both your development workflow and your Google Cloud Platform resources while this is the Google Cloud Client Library for Node.js.
22+
23+
## Does this replace [Google Cloud Node.js Client][googleapis]?
24+
25+
Google Cloud Node.js Client is a client library for using the broad set of Google APIs. `gcloud` 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.
26+
27+
[dev-console]: https://console.developers.google.com/project
28+
[gce-how-to]: https://developers.google.com/compute/docs/authentication#using
29+
[googleapis]: https://github.com/google/google-api-nodejs-client

docs/index.html

+16-9
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
<meta name="description" content="Node idiomatic client for Google Cloud services.">
1111
<meta name="viewport" content="width=device-width, initial-scale=1">
1212
<link rel="shortcut icon" href="https://cloud.google.com/images/gcp-favicon.ico">
13-
<link rel="stylesheet" href="css/normalize.css">
14-
<link rel="stylesheet" href="css/main.css">
13+
<link rel="stylesheet" href="site/css/normalize.css">
14+
<link rel="stylesheet" href="site/css/main.css">
1515
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Droid+Sans+Mono|Roboto:300,400,700,700italic,400italic|Open+Sans:300">
1616
<link rel="stylesheet" href="//yandex.st/highlightjs/8.0/styles/github.min.css">
1717
</head>
@@ -23,15 +23,22 @@
2323
<main ng-view autoscroll="true"></main>
2424

2525
<script src="//ajax.googleapis.com/ajax/libs/angularjs/1.2.23/angular.min.js"></script>
26-
<script src="//code.angularjs.org/1.2.23/angular-route.js"></script>
26+
<script src="//code.angularjs.org/1.2.23/angular-route.min.js"></script>
27+
<script src="//code.angularjs.org/1.2.23/angular-sanitize.min.js"></script>
2728
<script src="//yandex.st/highlightjs/8.0/highlight.min.js"></script>
2829
<script src="//pc035860.github.io/angular-highlightjs/angular-highlightjs.min.js"></script>
29-
<script src="lib/node-semver/semver.browser.js"></script>
30-
<script src="home.js"></script>
31-
<script src="components/docs/docs.js"></script>
32-
<script src="components/docs/docs-directives.js"></script>
33-
<script src="components/docs/docs-services.js"></script>
34-
<script src="components/docs/docs-values.js"></script>
30+
<script src="//cdnjs.cloudflare.com/ajax/libs/showdown/0.3.1/showdown.min.js"></script>
31+
<script src="site/lib/node-semver/semver.browser.js"></script>
32+
<script src="site/lib/angular-markdown-directive/markdown.js"></script>
33+
<script src="site/home.js"></script>
34+
<script src="site/components/docs/docs.js"></script>
35+
<script src="site/components/docs/docs-directives.js"></script>
36+
<script src="site/components/docs/docs-services.js"></script>
37+
<script src="site/components/docs/docs-values.js"></script>
38+
<script src="site/components/faq/faq.js"></script>
39+
<script src="site/components/subpage/subpage-directive.js"></script>
40+
<script src="site/components/header/header-directive.js"></script>
41+
<script src="site/components/troubleshooting/troubleshooting.js"></script>
3542

3643
<script>
3744
(function() {

0 commit comments

Comments
 (0)