Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

Commit

Permalink
fix(docs): add repo-metadata file (#722)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinBeckwith authored Jun 24, 2019
1 parent 7f412a6 commit 1390590
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 219 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ package-lock.json
.nyc_output
key.json
docs/
__pycache__
12 changes: 12 additions & 0 deletions .repo-metadata.json
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"
}
236 changes: 59 additions & 177 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
"split": "^1.0.0"
},
"devDependencies": {
"@compodoc/compodoc": "^1.1.7",
"@compodoc/compodoc": "1.1.8",
"@types/acorn": "^4.0.2",
"@types/console-log-level": "^1.4.0",
"@types/estree": "0.0.39",
Expand Down
68 changes: 30 additions & 38 deletions samples/README.md
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
2 changes: 1 addition & 1 deletion synth.metadata
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"updateTime": "2019-06-18T00:57:04.238582Z",
"updateTime": "2019-06-22T17:42:37.072172Z",
"sources": [
{
"template": {
Expand Down
2 changes: 0 additions & 2 deletions synth.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
import logging

logging.basicConfig(level=logging.DEBUG)

common_templates = gcp.CommonTemplates()

templates = common_templates.node_library()
# stop excluding '.kokoro/test.bat' as soon as we figure out why Node 10 tests
# have issues on Windows (see #686).
Expand Down

0 comments on commit 1390590

Please sign in to comment.