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

Closed
10 tasks
omaray opened this issue Dec 6, 2016 · 1 comment
Closed
10 tasks

Update ReadMe to reflect quality levels of client libraries #1862

omaray opened this issue Dec 6, 2016 · 1 comment
Assignees

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

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

Listing Beta client libraries

  • 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

@stephenplusplus
Copy link
Contributor

PR sent: #1864

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants