Skip to content
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

Expand scope of gh-pages site to include non-API docs #326

Merged
merged 2 commits into from
Dec 22, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 0 additions & 209 deletions docs/components/docs/docs.html

This file was deleted.

29 changes: 29 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## How do I use `gcloud` with Google Compute Engine?

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.

## I'm not using Compute Engine. What do I need to do?

If you are not running this client on Google Compute Engine, you need a Google Developers service account. To create a service account:

1. Visit the [Google Developers Console][dev-console].
2. Create a new project or click on an existing project.
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):
* Google Cloud Datastore API
* Google Cloud Storage
* Google Cloud Storage JSON API
4. Navigate to **APIs & auth** > **Credentials** and then:
* 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.
* 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.

## What is the relationship between this and the `gcloud` command-line tool?

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.

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

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.

[dev-console]: https://console.developers.google.com/project
[gce-how-to]: https://developers.google.com/compute/docs/authentication#using
[googleapis]: https://github.com/google/google-api-nodejs-client
25 changes: 16 additions & 9 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
<meta name="description" content="Node idiomatic client for Google Cloud services.">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" href="https://cloud.google.com/images/gcp-favicon.ico">
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/main.css">
<link rel="stylesheet" href="site/css/normalize.css">
<link rel="stylesheet" href="site/css/main.css">
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Droid+Sans+Mono|Roboto:300,400,700,700italic,400italic|Open+Sans:300">
<link rel="stylesheet" href="//yandex.st/highlightjs/8.0/styles/github.min.css">
</head>
Expand All @@ -23,15 +23,22 @@
<main ng-view autoscroll="true"></main>

<script src="//ajax.googleapis.com/ajax/libs/angularjs/1.2.23/angular.min.js"></script>
<script src="//code.angularjs.org/1.2.23/angular-route.js"></script>
<script src="//code.angularjs.org/1.2.23/angular-route.min.js"></script>
<script src="//code.angularjs.org/1.2.23/angular-sanitize.min.js"></script>
<script src="//yandex.st/highlightjs/8.0/highlight.min.js"></script>
<script src="//pc035860.github.io/angular-highlightjs/angular-highlightjs.min.js"></script>
<script src="lib/node-semver/semver.browser.js"></script>
<script src="home.js"></script>
<script src="components/docs/docs.js"></script>
<script src="components/docs/docs-directives.js"></script>
<script src="components/docs/docs-services.js"></script>
<script src="components/docs/docs-values.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/showdown/0.3.1/showdown.min.js"></script>
<script src="site/lib/node-semver/semver.browser.js"></script>
<script src="site/lib/angular-markdown-directive/markdown.js"></script>
<script src="site/home.js"></script>
<script src="site/components/docs/docs.js"></script>
<script src="site/components/docs/docs-directives.js"></script>
<script src="site/components/docs/docs-services.js"></script>
<script src="site/components/docs/docs-values.js"></script>
<script src="site/components/faq/faq.js"></script>
<script src="site/components/subpage/subpage-directive.js"></script>
<script src="site/components/header/header-directive.js"></script>
<script src="site/components/troubleshooting/troubleshooting.js"></script>

<script>
(function() {
Expand Down
Loading