Skip to content
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.

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

Add alpha and beta references to README.rst. #2821

Merged
merged 7 commits into from
Dec 8, 2016

Conversation

daspecster
Copy link
Contributor

Towards #2820.

@daspecster daspecster added the docs label Dec 6, 2016
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Dec 6, 2016
- `Google Cloud Vision`_ (`Vision README`_)
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_)
- `Google Cloud Runtime Configuration`_ (`Runtime Config README`_)

This comment was marked as spam.

This comment was marked as spam.

- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_)
- `Google Cloud Runtime Configuration`_ (`Runtime Config README`_)

This client supports the following Google Cloud Platform services at a Beta_ quality level:

This comment was marked as spam.

This comment was marked as spam.

- `Google BigQuery`_ (`BigQuery README`_) (Beta)
- `Google Cloud Datastore`_ (`Datastore README`_) (Beta)
- `Stackdriver Logging`_ (`Logging README`_) (Beta)
- `Google Cloud Storage`_ (`Storage README`_) (Beta)

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

- `Google Translate`_ (`Translate README`_) (Alpha)
- `Google Cloud Vision`_ (`Vision README`_) (Alpha)
- `Google Cloud Bigtable - HappyBase`_ (`HappyBase README`_) (Alpha)
- `Google Cloud Runtime Configuration`_ (`Runtime Config README`_) (Alpha)

This comment was marked as spam.

.. _Alpha: #versioning
.. _Beta: #versioning

Versioning

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

- `Stackdriver Logging`_ (`Logging README`_) (Beta)
- `Google Cloud Storage`_ (`Storage README`_) (Beta)


This comment was marked as spam.

@@ -70,6 +70,8 @@ This client supports the following Google Cloud Platform services at an Alpha_ q
If you need support for other Google APIs, check out the
`Google APIs Python Client library`_.

.. _Alpha: https://cloud.google.com/terms/launch-stages
.. _Beta: https://cloud.google.com/terms/launch-stages

This comment was marked as spam.

This comment was marked as spam.

@omaray
Copy link
Contributor

omaray commented Dec 8, 2016

Hey guys. So the Beta/Alpha links you gave was a good attempt! But these apply to the Services in Google Cloud (and doesn't apply to client libraries really). So for now the idea is to just add what "Beta" and "Alpha" means in the Versioning section. We can always change later or have a centralized location in gcloud-common or something. But at least it gives a succinct explanation. You can see the PR for PHP as a reference: googleapis/google-cloud-php#274 (which you probably already have).

High Priority: Pub/Sub is NOT Beta. Please we need to put in the Alpha section!

@daspecster
Copy link
Contributor Author

@omaray I moved Pub/Sub to the Alpha section and put the Version section back.

Let me know if this looks good to you?

@tseaver
Copy link
Contributor

tseaver commented Dec 8, 2016

@omaray Out of curiousity, what is the rationale for holding Pub/Sub as "alpha"? I don't recall any discussion of it, and we've been talking about the "fab five" for months.

@dhermes
Copy link
Contributor

dhermes commented Dec 8, 2016

@daspecster @omaray FWIW, whether Pub/Sub is part of some big picture or not, we are treating it (local to Python) like it is "beta" quality.

@daspecster
Copy link
Contributor Author

daspecster commented Dec 8, 2016

@dhermes @omaray what if we changed the verbage to something like...

+ This client supports the following Beta Google Cloud Platform services
- This client supports the following Google Cloud Platform services at a Beta quality level

Or something to try and note that we're referencing the upstream services.

Then we could add the (beta)/(alpha) references back to the APIs to denote the level that this library supports those services.

## Alpha GCP services:

- Pub/Sub (beta)
- Vision (alpha)
- Speech (alpha)
...

## Beta GCP services:

- BigQuery (beta)
- Datastore (beta)
...

@googlebot
Copy link

We found a Contributor License Agreement for you (the sender of this pull request) and all commit authors, but as best as we can tell these commits were authored by someone else. If that's the case, please add them to this pull request and have them confirm that they're okay with these commits being contributed to Google. If we're mistaken and you did author these commits, just reply here to confirm.

@googlebot googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Dec 8, 2016
@@ -15,14 +15,21 @@ Google Cloud Python Client
.. _API Documentation: https://googlecloudplatform.github.io/google-cloud-python/stable/
.. _Read The Docs Documentation: https://google-cloud-python.readthedocs.io/en/latest/

This client supports the following Google Cloud Platform services:
This client supports the following Google Cloud Platform services at **Beta**:

This comment was marked as spam.

- `Google Cloud Storage`_ (`Storage README`_)

Libraries defined as **Beta** quality are expected to be mostly stable and

This comment was marked as spam.

we're working towards their release candidate. We will address issues and
requests with a higher priority.

This client supports the following Google Cloud Platform services at **Alpha**:

This comment was marked as spam.

@dhermes dhermes merged commit 4a0225d into googleapis:master Dec 8, 2016
@daspecster daspecster deleted the mark-beta-in-readme branch January 24, 2017 15:16
richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017
* Add alpha and beta references to README.rst.

* Clean up spacing.

* Remove redundant labeling.

* Move Pub/Sub to Alpha section.

* Clarifying Alpha/Beta label.

* Removing stray edit.

* Jon Wayne comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: no This human has *not* signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants