Skip to content

Commit

Permalink
docs: update jsdoc license/samples-README (#340)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe authored Dec 24, 2019
1 parent 2d911a3 commit f07727a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
29 changes: 14 additions & 15 deletions packages/google-cloud-monitoring/.jsdoc.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
/*!
* Copyright 2018 Google LLC. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

'use strict';

Expand Down
16 changes: 11 additions & 5 deletions packages/google-cloud-monitoring/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ and a variety of common application components including Cassandra, Nginx, Apach
Before running the samples, make sure you've followed the steps outlined in
[Using the client library](https://github.com/googleapis/nodejs-monitoring#using-the-client-library).

`cd samples`

`npm install`

`cd ..`

## Samples


Expand All @@ -37,7 +43,7 @@ View the [source code](https://github.com/googleapis/nodejs-monitoring/blob/mast
__Usage:__


`node alerts.js`
`node samples/alerts.js`


-----
Expand All @@ -54,7 +60,7 @@ View the [source code](https://github.com/googleapis/nodejs-monitoring/blob/mast
__Usage:__


`node metrics.js`
`node samples/metrics.js`


-----
Expand All @@ -71,7 +77,7 @@ View the [source code](https://github.com/googleapis/nodejs-monitoring/blob/mast
__Usage:__


`node quickstart.js`
`node samples/quickstart.js`


-----
Expand All @@ -88,7 +94,7 @@ View the [source code](https://github.com/googleapis/nodejs-monitoring/blob/mast
__Usage:__


`node uptime.js`
`node samples/uptime.js`



Expand All @@ -97,4 +103,4 @@ __Usage:__

[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/nodejs-monitoring&page=editor&open_in_editor=samples/README.md
[product-docs]: https://cloud.google.com/monitoring/docs
[product-docs]: https://cloud.google.com/monitoring/docs

0 comments on commit f07727a

Please sign in to comment.