chore: update synthconfig to include generation of README.md (#306)

googleapis · Jul 23, 2020 · 557e669 · 557e669
1 parent 8cd2d5b
commit 557e669
Show file tree

Hide file tree

Showing 4 changed files with 122 additions and 67 deletions.
diff --git a/.repo-metadata.json b/.repo-metadata.json
@@ -10,5 +10,7 @@
   "repo_short": "java-firestore",
   "distribution_name": "com.google.cloud:google-cloud-firestore",
   "codeowner_team": "@googleapis/firestore-dpe",
-  "api_id": "firestore.googleapis.com"
+  "api_id": "firestore.googleapis.com",
+  "api_description": "is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform.  It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.",
+  "transport": "grpc"
 }
diff --git a/README.md b/README.md
@@ -1,43 +1,50 @@
-Google Cloud Java Client for Firestore
-=================================
+# Google Cloud Firestore Client for Java
 
-[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
-[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-firestore.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-firestore.svg)
-[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
+Java idiomatic client for [Cloud Firestore][product-docs].
 
--  [Product Documentation](https://cloud.google.com/firestore/docs/)
--  [Client Library Documentation](https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/firestore/package-summary.html)
+[![Maven][maven-version-image]][maven-version-link]
+![Stability][stability-image]
 
-Quickstart
-----------
-If you are using Maven with a BOM, add this to your pom.xml file.
+- [Product Documentation][product-docs]
+- [Client Library Documentation][javadocs]
+
+## Quickstart
+
+If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
 ```xml
 <dependencyManagement>
- <dependencies>
+  <dependencies>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>libraries-bom</artifactId>
+      <version>8.0.0</version>
+      <type>pom</type>
+      <scope>import</scope>
+    </dependency>
+  </dependencies>
+</dependencyManagement>
+
+<dependencies>
   <dependency>
     <groupId>com.google.cloud</groupId>
-    <artifactId>libraries-bom</artifactId>
-    <version>3.1.0</version>
-    <type>pom</type>
-    <scope>import</scope>
-   </dependency>
- </dependencies>
-</dependencyManagement>
+    <artifactId>google-cloud-firestore</artifactId>
+  </dependency>
 
-<dependency>
-  <groupId>com.google.cloud</groupId>
-  <artifactId>google-cloud-firestore</artifactId>
-</dependency>
 ```
-[//]: # ({x-version-update-start:google-cloud-firestore:released})
-If you are using Maven without a BOM, add this to your dependencies.
+
+If you are using Maven without BOM, add this to your dependencies:
+
 ```xml
 <dependency>
   <groupId>com.google.cloud</groupId>
   <artifactId>google-cloud-firestore</artifactId>
   <version>1.35.2</version>
 </dependency>
+
 ```
+
+[//]: # ({x-version-update-start:google-cloud-firestore:released})
+
 If you are using Gradle, add this to your dependencies
 ```Groovy
 compile 'com.google.cloud:google-cloud-firestore:1.35.2'
@@ -48,58 +55,105 @@ libraryDependencies += "com.google.cloud" % "google-cloud-firestore" % "1.35.2"
 ```
 [//]: # ({x-version-update-end})
 
-Authentication
---------------
+## Authentication
 
-See the
-[Authentication](https://github.com/googleapis/google-cloud-java#authentication)
-section in the base directory's README.
+See the [Authentication][authentication] section in the base directory's README.
 
-About Google Cloud Firestore
-----------------------------
+## Getting Started
 
-Cloud Firestore is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform.  It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.
+### Prerequisites
 
-Troubleshooting
----------------
+You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Firestore [API enabled][enable-api].
 
-To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
+[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]`.
 
-Transport
----------
-Firestore uses gRPC for the transport layer.
+### Installation and setup
 
-Java Versions
--------------
+You'll need to obtain the `google-cloud-firestore` library.  See the [Quickstart](#quickstart) section
+to add `google-cloud-firestore` as a dependency in your code.
 
-Java 7 or above is required for using this client.
+## About Cloud Firestore
 
-Versioning
-----------
 
-This library follows [Semantic Versioning](http://semver.org/).
+[Cloud Firestore][product-docs] is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform.  It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.
 
-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.
+See the [Cloud Firestore client library docs][javadocs] to learn how to
+use this Cloud Firestore Client Library.
 
-Contributing
-------------
 
-Contributions to this library are always welcome and highly encouraged.
 
-See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on 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 information.
 
-License
--------
 
-Apache 2.0 - See [LICENSE] for more information.
+## Troubleshooting
+
+To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
+
+## Transport
+
+Cloud Firestore uses gRPC for the transport layer.
+
+## Java Versions
+
+Java 7 or above is required for using this client.
+
+## Versioning
+
+
+This library follows [Semantic Versioning](http://semver.org/).
+
+
+## Contributing
 
 
-[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
-[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
-[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
-[cloud-platform]: https://cloud.google.com/
-[developers-console]:https://console.developers.google.com/
+Contributions to this library are always welcome and highly encouraged.
+
+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
+information.
+
+## License
+
+Apache 2.0 - See [LICENSE][license] for more information.
+
+## CI Status
+
+Java Version | Status
+------------ | ------
+Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
+Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
+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]
+
+[product-docs]: https://cloud.google.com/firestore
+[javadocs]: https://googleapis.dev/java/google-cloud-firestore/latest
+[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java7.svg
+[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java7.html
+[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java8.svg
+[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java8.html
+[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java8-osx.svg
+[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java8-osx.html
+[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java8-win.svg
+[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java8-win.html
+[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java11.svg
+[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-firestore/java11.html
+[stability-image]: https://img.shields.io/badge/stability-ga-green
+[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-firestore.svg
+[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-firestore&core=gav
+[authentication]: https://github.com/googleapis/google-cloud-java#authentication
+[developer-console]: https://console.developers.google.com/
+[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
+[cloud-sdk]: https://cloud.google.com/sdk/
+[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
+[contributing]: https://github.com/googleapis/java-firestore/blob/master/CONTRIBUTING.md
+[code-of-conduct]: https://github.com/googleapis/java-firestore/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
+[license]: https://github.com/googleapis/java-firestore/blob/master/LICENSE
+
+[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=firestore.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
@@ -3,23 +3,23 @@
     {
       "git": {
         "name": ".",
-        "remote": "https://github.com/googleapis/java-firestore.git",
-        "sha": "03b37056e1ae8f80373e0acc6bff82b9161f2182"
+        "remote": "git@github.com:BenWhitehead/java-firestore.git",
+        "sha": "1c89a1c28c865974cb702c1025ed7322600f639c"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "cbd6f1d28bc0c461c234f9848bcbc1563126daf9",
-        "internalRef": "319105199"
+        "sha": "1f8c042337a305fbf71db7fa768563fe7b9df60d",
+        "internalRef": "322592423"
       }
     },
     {
       "git": {
         "name": "synthtool",
         "remote": "https://github.com/googleapis/synthtool.git",
-        "sha": "303271797a360f8a439203413f13a160f2f5b3b4"
+        "sha": "1f7dc35918f7ba2ca11b074d083ffe7d3856fa41"
       }
     }
   ],

diff --git a/synth.py b/synth.py
@@ -122,7 +122,6 @@ def generate_client(service, version, proto_path=None, bazel_target=None, packag
 )
 
 java.common_templates(excludes=[
-    'README.md',
     # firestore uses a different project for its integration tests
     # due to the default project running datastore
     '.kokoro/presubmit/integration.cfg',