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 #1102

Closed
11 tasks done
omaray opened this issue Dec 6, 2016 · 3 comments · Fixed by #1114
Closed
11 tasks done

Update ReadMe to reflect quality levels of client libraries #1102

omaray opened this issue Dec 6, 2016 · 3 comments · Fixed by #1114
Assignees
Labels
release blocking Required feature/issue must be fixed prior to next release.

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 the canonical example to follow. The list below highlights the main changes to follow for this repo.

General

  • Title: change from google-cloud-ruby to Google Cloud Ruby Client (for consistency)

Listing Beta client libraries

  • Remove the text "This project supports the following Google cloud Platform services:"

  • Create a section to show the Beta client libraries (see image right below for text & layout)

  • Make the term Beta link to the Versioning section of the ReadMe (see image right below)

  • Add the term (Beta) next to each API name (see image right below for text and visual):

image

Listing Alpha client libraries

  • Create a section to show the Alpha client libraries (see image right below for text and layout)

  • Make the term Alpha link to the Versioning section of the ReadMe (see image right below)

  • Add the term (Alpha) next to each API name (see image right below for text and visual):

image

Client Library per API section

  • If there is a section in the ReadMe for each API, add the term (Beta) or (Alpha) appropriately (see image right below for visual):

image

Versioning section

  • If the Versioning section doesn't exist, add one.

  • Add the following content in the Versioning section:

image

@omaray omaray added release blocking Required feature/issue must be fixed prior to next release. docs labels Dec 6, 2016
@quartzmo
Copy link
Member

quartzmo commented Dec 7, 2016

@omaray Can a PR for this issue be merged into master now, or does it need to wait for release?

quartzmo added a commit to quartzmo/google-cloud-ruby that referenced this issue Dec 7, 2016
Add documentation of Beta and Alpha packages.

[closes googleapis#1102]
@omaray
Copy link
Author

omaray commented Dec 8, 2016

Hey! Let's wait until we do the release of the new gems. Then we can update the ReadMe on Friday (we'll send an email on Thursday to confirm it all).

@quartzmo
Copy link
Member

quartzmo commented Dec 8, 2016 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release blocking Required feature/issue must be fixed prior to next release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants