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

Update ReadMe to reflect quality levels of client libraries #450

Closed
3 tasks done
omaray opened this issue Dec 6, 2016 · 3 comments
Closed
3 tasks done

Update ReadMe to reflect quality levels of client libraries #450

omaray opened this issue Dec 6, 2016 · 3 comments
Assignees
Labels
🚨 This issue needs some love. triage me I really want to be triaged.

Comments

@omaray
Copy link

omaray commented Dec 6, 2016

We will soon have client libraries at different quality levels. Let's make sure we reflect this information in our top-level ReadMe file the moment we cut the new release.

The update for PHP's ReadMe has already be done (as a Pull Request for now) and can be used as a good example we can follow.

Go seems to have its own thing going on in the ReadMe. I would suggest looking at the PHP example to see what could be ported over. I would list at least the following:

  • Update the Supported APIs to show what is truly Beta and what is not

  • Is Experimental the same as Alpha? Should we change the wording? If Experimental is expected in Go then that's fine too.

  • Perhaps we can move the "News" section elsewhere? Seems like it should go in the "releases" part of the repo. But maybe with Go that's not possible? Or at least reduce the size of the section perhaps?

@jba
Copy link
Contributor

jba commented Dec 6, 2016

First checkbox is done in https://code-review.googlesource.com/9750.

Experimental has no special meaning in Go; we can use Alpha if you prefer. Just let me know.

I shortened the news section (https://code-review.googlesource.com/#/c/9751). But I will be putting an announcement about beta at the top of news, so everyone will see it first.

@omaray
Copy link
Author

omaray commented Dec 8, 2016

Thanks Jonathan. Yes, if Experimental has no special meaning then let's call it Alpha. This way it will be consistent with the other language libraries.

@omaray
Copy link
Author

omaray commented Dec 8, 2016

Also, can we add somewhere a description for what Beta and Alpha means? In the PHP example you'll see that we have a Versioning section that explains Beta/Alpha towards the end: https://github.com/omaray/google-cloud-php/blob/readme-update-beta/README.md

Can we do something similar in Go? I guess people might wonder what alpha/beta means.

@jba jba self-assigned this Dec 27, 2016
@jba jba closed this as completed Jan 3, 2017
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚨 This issue needs some love. triage me I really want to be triaged.
Projects
None yet
Development

No branches or pull requests

3 participants