chore: generate README from templates (#40)

googleapis · Feb 25, 2020 · e2c2f7d · e2c2f7d
1 parent 1e78e64
commit e2c2f7d
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 29 deletions.
diff --git a/.repo-metadata.json b/.repo-metadata.json
@@ -3,10 +3,13 @@
   "name_pretty": "Google Cloud Monitoring Dashboards",
   "product_documentation": "https://cloud.google.com/monitoring/charts/dashboards",
   "client_documentation": "https://googleapis.dev/java/java-monitoring-dashboards/latest",
+  "api_description": "are one way for you to view and analyze metric data. The Cloud Console provides predefined dashboards that require no setup or configuration. You can also define custom dashboards. With custom dashboards, you have complete control over the charts that are displayed and their configuration.",
   "release_level": "beta",
   "language": "java",
   "repo": "googleapis/java-monitoring-dashboards",
   "repo_short": "java-monitoring-dashboards",
   "distribution_name": "com.google.cloud:google-cloud-monitoring-dashboards",
-  "api_id": "monitoring.googleapis.com"
+  "api_id": "monitoring.googleapis.com",
+  "transport": "grpc",
+  "requires_billing": true
 }
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Google Cloud Java Client for Google Cloud Monitoring Dashboards
+# Google Google Cloud Monitoring Dashboards Client for Java
 
-Java idiomatic client for [Google Cloud Monitoring Dashboards][api-reference].
+Java idiomatic client for [Google Cloud Monitoring Dashboards][product-docs].
 
 [![Maven][maven-version-image]][maven-version-link]
 ![Stability][stability-image]
@@ -13,15 +13,39 @@ Java idiomatic client for [Google Cloud Monitoring Dashboards][api-reference].
 
 ## Quickstart
 
-[//]: # ({x-version-update-start:monitoring-dashboards:released})
-If you are using Maven, add this to your pom.xml file
+If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
+```xml
+<dependencyManagement>
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>libraries-bom</artifactId>
+      <version>4.1.1</version>
+      <type>pom</type>
+      <scope>import</scope>
+    </dependency>
+  </dependencies>
+</dependencyManagement>
+<dependencies>
+  <dependency>
+    <groupId>com.google.cloud</groupId>
+    <artifactId>google-cloud-monitoring-dashboards</artifactId>
+  </dependency>
+</dependencies>
+```
+
+[//]: # ({x-version-update-start:google-cloud-monitoring-dashboards:released})
+
+If you are using Maven without BOM, add this to your dependencies:
+
 ```xml
 <dependency>
   <groupId>com.google.cloud</groupId>
   <artifactId>google-cloud-monitoring-dashboards</artifactId>
   <version>0.0.0</version>
 </dependency>
 ```
+
 If you are using Gradle, add this to your dependencies
 ```Groovy
 compile 'com.google.cloud:google-cloud-monitoring-dashboards:0.0.0'
@@ -36,22 +60,13 @@ libraryDependencies += "com.google.cloud" % "google-cloud-monitoring-dashboards"
 
 See the [Authentication][authentication] section in the base directory's README.
 
-## About Google Cloud Monitoring Dashboards
-
-[Google Cloud Monitoring Dashboards][api-reference] are one way for you to view and analyze metric
-data that is important to you. The Stackdriver Monitoring console provides predefined dashboards for
-the resources and services that you use. These dashboards require no setup or configuration effort.
-
-See the [Google Cloud Monitoring Dashboards client library docs][javadocs] to learn how to
-use this Google Cloud Monitoring Dashboards Client Library.
-
 ## Getting Started
 
 ### Prerequisites
 
-You will need a [Google Developers Console][developer-console] project with the
-Google Cloud Monitoring Dashboards API enabled. [Follow these instructions][create-project] to get your
-project set up. You will also need to set up the local development environment by
+You will need a [Google Cloud Platform Console][developer-console] project with the Google Cloud Monitoring Dashboards [API enabled][enable-api].
+You will need to [enable billing][enable-billing] to use Google Google Cloud Monitoring Dashboards.
+[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
 [installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
 `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
 
@@ -60,6 +75,19 @@ project set up. You will also need to set up the local development environment b
 You'll need to obtain the `google-cloud-monitoring-dashboards` library.  See the [Quickstart](#quickstart) section
 to add `google-cloud-monitoring-dashboards` as a dependency in your code.
 
+## About Google Cloud Monitoring Dashboards
+
+
+[Google Cloud Monitoring Dashboards][product-docs] are one way for you to view and analyze metric data. The Cloud Console provides predefined dashboards that require no setup or configuration. You can also define custom dashboards. With custom dashboards, you have complete control over the charts that are displayed and their configuration.
+
+See the [Google Cloud Monitoring Dashboards client library docs][javadocs] to learn how to
+use this Google Cloud Monitoring Dashboards Client Library.
+
+
+
+
+
+
 ## Troubleshooting
 
 To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
@@ -76,14 +104,17 @@ Java 7 or above is required for using this client.
 
 This library follows [Semantic Versioning](http://semver.org/).
 
+
 It is currently in major version zero (``0.y.z``), which means that anything may change at any time
 and the public API should not be considered stable.
 
+
 ## Contributing
 
+
 Contributions to this library are always welcome and highly encouraged.
 
-See [CONTRIBUTING.md][contributing] documentation for more information on how to get started.
+See [CONTRIBUTING][contributing] for more information how to get started.
 
 Please note that this project is released with a Contributor Code of Conduct. By participating in
 this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
@@ -103,7 +134,6 @@ Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
 Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
 Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
 
-[api-reference]: https://cloud.google.com/monitoring/dashboards/api-dashboard
 [product-docs]: https://cloud.google.com/monitoring/charts/dashboards
 [javadocs]: https://googleapis.dev/java/java-monitoring-dashboards/latest
 [kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-monitoring-dashboards/java7.svg
@@ -126,4 +156,8 @@ Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
 [troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
 [contributing]: https://github.com/googleapis/java-monitoring-dashboards/blob/master/CONTRIBUTING.md
 [code-of-conduct]: https://github.com/googleapis/java-monitoring-dashboards/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
-[license]: https://github.com/googleapis/java-monitoring-dashboards/blob/master/LICENSE
+[license]: https://github.com/googleapis/java-monitoring-dashboards/blob/master/LICENSE
+[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
+[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=monitoring.googleapis.com
+[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
+[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
diff --git a/synth.metadata b/synth.metadata
@@ -1,13 +1,12 @@
 {
-  "updateTime": "2020-02-24T23:00:09.572385Z",
+  "updateTime": "2020-02-25T18:34:31.886863Z",
   "sources": [
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "1e47e676cddbbd8d93f19ba0665af15b5532417e",
-        "internalRef": "296901854",
-        "log": "1e47e676cddbbd8d93f19ba0665af15b5532417e\nFix: Restore a method signature for UpdateCluster\n\nPiperOrigin-RevId: 296901854\n\n"
+        "sha": "0b1876b35e98f560f9c9ca9797955f020238a092",
+        "internalRef": "296986742"
       }
     },
     {

diff --git a/synth.py b/synth.py
@@ -33,8 +33,4 @@
         bazel_target=f'//google/monitoring/dashboard/{version}:google-cloud-monitoring-dashboard-{version}-java',
     )
 
-common_templates = gcp.CommonTemplates()
-templates = common_templates.java_library()
-s.copy(templates, excludes=[
-    'README.md',
-])
+java.common_templates()