feat: add .repo-metadata for README generation (#263)

googleapis · Jun 6, 2019 · d0bd7b7 · d0bd7b7
1 parent 5b350a4
commit d0bd7b7
Show file tree

Hide file tree

Showing 5 changed files with 154 additions and 200 deletions.
diff --git a/packages/google-cloud-monitoring/.gitignore b/packages/google-cloud-monitoring/.gitignore
@@ -12,3 +12,4 @@ system-test/*key.json
 google-cloud-logging-winston-*.tgz
 google-cloud-logging-bunyan-*.tgz
 package-lock.json
+__pycache__
diff --git a/packages/google-cloud-monitoring/.readme-partials.yml b/packages/google-cloud-monitoring/.readme-partials.yml
@@ -0,0 +1,4 @@
+introduction: |-
+        [Stackdriver Monitoring](https://cloud.google.com/monitoring/docs) collects metrics, events, and metadata from
+        Google Cloud Platform, Amazon Web Services (AWS), hosted uptime probes, application instrumentation,
+        and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch and many others.
diff --git a/packages/google-cloud-monitoring/.repo-metadata.json b/packages/google-cloud-monitoring/.repo-metadata.json
@@ -0,0 +1,13 @@
+{
+  "name": "monitoring",
+  "name_pretty": "Stackdriver Monitoring",
+  "product_documentation": "https://cloud.google.com/monitoring/docs",
+  "client_documentation": "https://cloud.google.com/nodejs/docs/reference/monitoring/latest/",
+  "issue_tracker": "https://issuetracker.google.com/savedsearches/559785",
+  "release_level": "beta",
+  "language": "nodejs",
+  "repo": "googleapis/nodejs-monitoring",
+  "distribution_name": "@google-cloud/monitoring",
+  "api_id": "monitoring.googleapis.com",
+  "requires_billing": true
+}
diff --git a/packages/google-cloud-monitoring/README.md b/packages/google-cloud-monitoring/README.md
@@ -1,21 +1,24 @@
 [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
-[//]: # "To regenerate it, use `npm run generate-scaffolding`."
+[//]: # "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"/>
 
 # [Stackdriver Monitoring: Node.js Client](https://github.com/googleapis/nodejs-monitoring)
 
-[![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style&#x3D;flat)](https://cloud.google.com/terms/launch-stages)
+[![release level](https://img.shields.io/badge/release%20level-beta-yellow.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
 [![npm version](https://img.shields.io/npm/v/@google-cloud/monitoring.svg)](https://www.npmjs.org/package/@google-cloud/monitoring)
 [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-monitoring/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-monitoring)
 
-> Node.js idiomatic client for [Monitoring][product-docs].
 
-[Stackdriver Monitoring](https://cloud.google.com/monitoring/docs) collects metrics, events, and metadata from Google Cloud Platform, Amazon Web Services (AWS), hosted uptime probes, application instrumentation, and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch and many others.
 
 
-* [Monitoring Node.js Client API Reference][client-docs]
+[Stackdriver Monitoring](https://cloud.google.com/monitoring/docs) collects metrics, events, and metadata from
+Google Cloud Platform, Amazon Web Services (AWS), hosted uptime probes, application instrumentation,
+and a variety of common application components including Cassandra, Nginx, Apache Web Server, Elasticsearch and many others.
+
+
+* [Stackdriver Monitoring Node.js Client API Reference][client-docs]
+* [Stackdriver Monitoring Documentation][product-docs]
 * [github.com/googleapis/nodejs-monitoring](https://github.com/googleapis/nodejs-monitoring)
-* [Monitoring Documentation][product-docs]
 
 Read more about the client libraries for Cloud APIs, including the older
 Google APIs Client Libraries, in [Client Libraries Explained][explained].
@@ -24,6 +27,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 **Table of contents:**
 
+
 * [Quickstart](#quickstart)
   * [Before you begin](#before-you-begin)
   * [Installing the client library](#installing-the-client-library)
@@ -37,112 +41,108 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 
 ### Before you begin
 
-1.  Select or create a Cloud Platform project.
-
-    [Go to the projects page][projects]
-
-1.  Enable billing for your project.
-
-    [Enable billing][billing]
-
-1.  Enable the Stackdriver Monitoring API.
-
-    [Enable the API][enable_api]
-
+1.  [Select or create a Cloud Platform project][projects].
+1.  [Enable billing for your project][billing].
+1.  [Enable the Stackdriver Monitoring API][enable_api].
 1.  [Set up authentication with a service account][auth] so you can access the
     API from your local workstation.
 
-[projects]: https://console.cloud.google.com/project
-[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
-[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=monitoring.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
-
 ### Installing the client library
 
-    npm install --save @google-cloud/monitoring
+```bash
+npm install @google-cloud/monitoring
+```
+
 
 ### Using the client library
 
 ```javascript
 // Imports the Google Cloud client library
 const monitoring = require('@google-cloud/monitoring');
 
-// Your Google Cloud Platform project ID
-const projectId = 'YOUR_PROJECT_ID';
+async function quickstart() {
+  // Your Google Cloud Platform project ID
+  const projectId = process.env.GCLOUD_PROJECT || 'YOUR_PROJECT_ID';
 
-// Creates a client
-const client = new monitoring.MetricServiceClient();
+  // Creates a client
+  const client = new monitoring.MetricServiceClient();
 
-// Prepares an individual data point
-const dataPoint = {
-  interval: {
-    endTime: {
-      seconds: Date.now() / 1000,
+  // Prepares an individual data point
+  const dataPoint = {
+    interval: {
+      endTime: {
+        seconds: Date.now() / 1000,
+      },
+    },
+    value: {
+      // The amount of sales
+      doubleValue: 123.45,
     },
-  },
-  value: {
-    // The amount of sales
-    doubleValue: 123.45,
-  },
-};
-
-// Prepares the time series request
-const request = {
-  name: client.projectPath(projectId),
-  timeSeries: [
-    {
-      // Ties the data point to a custom metric
-      metric: {
-        type: 'custom.googleapis.com/stores/daily_sales',
-        labels: {
-          store_id: 'Pittsburgh',
+  };
+
+  // Prepares the time series request
+  const request = {
+    name: client.projectPath(projectId),
+    timeSeries: [
+      {
+        // Ties the data point to a custom metric
+        metric: {
+          type: 'custom.googleapis.com/stores/daily_sales',
+          labels: {
+            store_id: 'Pittsburgh',
+          },
         },
-      },
-      resource: {
-        type: 'global',
-        labels: {
-          project_id: projectId,
+        resource: {
+          type: 'global',
+          labels: {
+            project_id: projectId,
+          },
         },
+        points: [dataPoint],
       },
-      points: [dataPoint],
-    },
-  ],
-};
-
-// Writes time series data
-client
-  .createTimeSeries(request)
-  .then(results => {
-    console.log(`Done writing time series data.`, results[0]);
-  })
-  .catch(err => {
-    console.error('ERROR:', err);
-  });
+    ],
+  };
+
+  // Writes time series data
+  const [result] = await client.createTimeSeries(request);
+  console.log(`Done writing time series data.`, result);
+}
+
 ```
 
+
+
 ## Samples
 
 Samples are in the [`samples/`](https://github.com/googleapis/nodejs-monitoring/tree/master/samples) directory. The samples' `README.md`
 has instructions for running the samples.
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
-| Alert Policies | [source code](https://github.com/googleapis/nodejs-monitoring/blob/master/samples/alerts.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-monitoring&page=editor&open_in_editor=samples/alerts.js,samples/README.md) |
+| Alerts | [source code](https://github.com/googleapis/nodejs-monitoring/blob/master/samples/alerts.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-monitoring&page=editor&open_in_editor=samples/alerts.js,samples/README.md) |
 | Metrics | [source code](https://github.com/googleapis/nodejs-monitoring/blob/master/samples/metrics.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-monitoring&page=editor&open_in_editor=samples/metrics.js,samples/README.md) |
-| Uptime Config | [source code](https://github.com/googleapis/nodejs-monitoring/blob/master/samples/uptime.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-monitoring&page=editor&open_in_editor=samples/uptime.js,samples/README.md) |
+| Quickstart | [source code](https://github.com/googleapis/nodejs-monitoring/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-monitoring&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
+| Uptime | [source code](https://github.com/googleapis/nodejs-monitoring/blob/master/samples/uptime.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-monitoring&page=editor&open_in_editor=samples/uptime.js,samples/README.md) |
+
 
-The [Monitoring Node.js Client API Reference][client-docs] documentation
+
+The [Stackdriver Monitoring Node.js Client API Reference][client-docs] documentation
 also contains samples.
 
 ## Versioning
 
 This library follows [Semantic Versioning](http://semver.org/).
 
+
+
 This library is considered to be in **beta**. This means it is expected to be
 mostly stable while we work toward a general availability release; however,
 complete stability is not guaranteed. We will address issues and requests
 against beta libraries with a high priority.
 
+
+
+
 More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 [launch_stages]: https://cloud.google.com/terms/launch-stages
@@ -160,4 +160,7 @@ See [LICENSE](https://github.com/googleapis/nodejs-monitoring/blob/master/LICENS
 [client-docs]: https://cloud.google.com/nodejs/docs/reference/monitoring/latest/
 [product-docs]: https://cloud.google.com/monitoring/docs
 [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
-
+[projects]: https://console.cloud.google.com/project
+[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
+[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=monitoring.googleapis.com
+[auth]: https://cloud.google.com/docs/authentication/getting-started