FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Update README files to declare this is an Alpha release. by coryan · Pull Request #385 · googleapis/google-cloud-cpp · GitHub

/ google-cloud-cpp Public

Update README files to declare this is an Alpha release. #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coryan merged 2 commits into from
Mar 28, 2018
Conversation 2 Commits 2 Checks 0 Files changed
Merged

Update README files to declare this is an Alpha release. #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3c3965
Update README files to declare "alpha" [skip ci].
coryan Mar 27, 2018
d31175a
Remove links to Java documentation.
coryan Mar 27, 2018
File filter

Filter by extension

Filter by extension .md  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
33 changes: 31 additions & 2 deletions README.md
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Google Cloud Platform C++ Client Libraries

C++ Idiomatic Clients for [Google Cloud Platform][cloud-platform] services.

[![Travis CI status][travis-shield]][travis-link]
[![AppVeyor CI status][appveyor-shield]][appveyor-link]
[![Codecov Coverage status][codecov-shield]][codecov-link]
[![Documentation][doxygen-shield]][doxygen-link]

- [Google Cloud Platform Documentation][cloud-platform-docs]

[travis-shield]: https://travis-ci.org/GoogleCloudPlatform/google-cloud-cpp.svg?branch=master
[travis-link]: https://travis-ci.org/GoogleCloudPlatform/google-cloud-cpp/builds
[appveyor-shield]: https://ci.appveyor.com/api/projects/status/d6srbtprnie4ufrx/branch/master?svg=true
Expand All @@ -13,15 +17,20 @@
[codecov-link]: https://codecov.io/gh/GoogleCloudPlatform/google-cloud-cpp
[doxygen-shield]: https://img.shields.io/badge/documentation-master-brightgreen.svg
[doxygen-link]: http://GoogleCloudPlatform.github.io/google-cloud-cpp/
[cloud-platform]: https://cloud.google.com/
[cloud-platform-docs]: https://cloud.google.com/docs/

This repo contains experimental client libraries for the following APIs:
This library supports the following Google Cloud Platform services with clients
at an [Alpha](#versioning) quality level:

* [Google Cloud Bigtable](bigtable/)
- [Google Cloud Bigtable](bigtable)

The libraries in this code base likely do not (yet) cover all the available
APIs. See the [`googleapis` repo](https://github.com/googleapis/googleapis)
for the full list of APIs callable using gRPC.

## Quick Start

To build the available libraries and run the tests, run the following commands
after cloning this repo:

Expand All @@ -35,6 +44,26 @@ make all
make test
```

## Versioning

This library follows [Semantic Versioning](http://semver.org/). Please note it
is currently under active development. Any release versioned 0.x.y is subject to
backwards incompatible changes at any time.

**GA**: Libraries defined at a GA quality level are expected to be stable and
all updates in the libraries are guaranteed to be backwards-compatible. Any
backwards-incompatible changes will lead to the major version increment
(1.x.y -> 2.0.0).

**Beta**: Libraries defined at a Beta quality level are expected to be mostly
stable and we're working towards their release candidate. We will address issues
and requests with a higher priority.

**Alpha**: Libraries defined at an Alpha quality level are still a
work-in-progress and are more likely to get backwards-incompatible updates.
Additionally, it's possible for Alpha libraries to get deprecated and deleted
before ever being promoted to Beta or GA.

## Contributing changes

See [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to contribute to
Expand Down
18 changes: 17 additions & 1 deletion bigtable/README.md
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,25 @@
[quickstart-link]: http://GoogleCloudPlatform.github.io/google-cloud-cpp/

This directory contains the implementation of the Google Cloud Bigtable C++
client. This is a work-in-progress and is not yet suitable for production use.
client.

## Status

This library support Google Cloud Bigtable at the
[Alpha](../README.md#versioning) quality level.

## Documentation

Full documentation, including a [quick start guide][quickstart-link]
is available [online][doxygen-link].

## Release Notes

mbrukman Mar 29, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Can you please add:

  1. a version number, and
  2. a date of release

so that this makes sense to readers in the future?

coryan Mar 29, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yup. I sent a small PR to fix this.

I think I should prepare a doc on how to create releases too, it is somewhat tricky.

* This release implements all the APIs for table and data manipulation in Cloud
Bigtable.
* This release does not implement APIs to manipulate instances, please use the
Google Cloud Bigtable
[command line tool](https://cloud.google.com/bigtable/docs/go/cbt-overview)
or any of the other programming language APIs instead.
* Only synchronous (blocking) APIs are implemented, asynchronous APIs are in
our roadmap.
Back | FazBrowse Home | New Git URL