This repository has been archived by the owner on Apr 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docs): add repo-metadata file (#722)
- Loading branch information
1 parent
7f412a6
commit 1390590
Showing
7 changed files
with
104 additions
and
219 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,4 @@ package-lock.json | |
.nyc_output | ||
key.json | ||
docs/ | ||
__pycache__ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"name": "debugger", | ||
"name_pretty": "Stackdriver Debugger", | ||
"product_documentation": "https://cloud.google.com/debugger", | ||
"client_documentation": "https://googleapis.dev/nodejs/debugger/latest/", | ||
"issue_tracker": "https://issuetracker.google.com/savedsearches/559771", | ||
"release_level": "beta", | ||
"language": "nodejs", | ||
"repo": "googleapis/cloud-debug-nodejs", | ||
"distribution_name": "@google-cloud/debug-agent", | ||
"api_id": "clouddebugger.googleapis.com" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,62 @@ | ||
# StackDriver Debugger sample for Node.js | ||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
[//]: # "To regenerate it, use `python -m synthtool`." | ||
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/> | ||
|
||
This sample demonstrates [StackDriver Debugger][debugger] with Node.js. | ||
# [Stackdriver Debugger: Node.js Samples](https://github.com/googleapis/cloud-debug-nodejs) | ||
|
||
* [Setup](#setup) | ||
* [Running locally](#running-locally) | ||
* [Deploying to App Engine](#deploying-to-app-engine) | ||
* [Running the tests](#running-the-tests) | ||
[![Open in Cloud Shell][shell_img]][shell_link] | ||
|
||
## Setup | ||
|
||
Before you can run or deploy the sample, you need to do the following (where | ||
appropriate, replace `YOUR_PROJECT_ID` with the ID of your Cloud project): | ||
|
||
1. Refer to the `@google-cloud/debug-agent` [README][readme] for instructions on | ||
running and deploying. | ||
## Table of Contents | ||
|
||
1. Set the `GCLOUD_PROJECT` environment variable: | ||
* [Before you begin](#before-you-begin) | ||
* [Samples](#samples) | ||
* [App](#app) | ||
* [Snippets](#snippets) | ||
|
||
Linux: | ||
## Before you begin | ||
|
||
export GCLOUD_PROJECT=your-project-id | ||
Before running the samples, make sure you've followed the steps outlined in | ||
[Using the client library](https://github.com/googleapis/cloud-debug-nodejs#using-the-client-library). | ||
|
||
Windows: | ||
## Samples | ||
|
||
set GCLOUD_PROJECT=your-project-id | ||
|
||
Windows (PowerShell): | ||
|
||
$env:GCLOUD_PROJECT="your-project-id" | ||
### App | ||
|
||
1. Acquire local credentials for authenticating with Google Cloud Platform APIs: | ||
View the [source code](https://github.com/googleapis/cloud-debug-nodejs/blob/master/samples/app.js). | ||
|
||
gcloud auth application-default login | ||
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/app.js,samples/README.md) | ||
|
||
1. Configure git to use gcloud SDK: | ||
__Usage:__ | ||
|
||
git config credential.helper gcloud.sh | ||
|
||
1. Add your Cloud Source Repository as a git remote: | ||
`node app.js` | ||
|
||
git remote add google https://source.developers.google.com/p/YOUR_PROJECT_ID/r/default | ||
|
||
1. Commit and push the code into the Cloud Source Repository: | ||
----- | ||
|
||
git add -A && git commit -m "Initial commit" && git push --all google | ||
|
||
1. Install dependencies: | ||
|
||
npm install | ||
|
||
## Running locally | ||
### Snippets | ||
|
||
npm start | ||
View the [source code](https://github.com/googleapis/cloud-debug-nodejs/blob/master/samples/snippets.js). | ||
|
||
[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/snippets.js,samples/README.md) | ||
|
||
## Deploying to App Engine | ||
__Usage:__ | ||
|
||
npm run deploy | ||
|
||
`node snippets.js` | ||
|
||
Use the [Stackdriver Debugger dashboard](https://console.cloud.google.com/debug) to inspect runtime data of the app. | ||
|
||
## Running the tests | ||
|
||
See [Contributing][contributing]. | ||
|
||
[debugger]: https://cloud.google.com/debugger/ | ||
[readme]: ../README.md | ||
[contributing]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/CONTRIBUTING.md | ||
|
||
|
||
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png | ||
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/README.md | ||
[product-docs]: https://cloud.google.com/debugger |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters