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

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

Update ReadMe to reflect quality levels of client libraries #618

omaray opened this issue Dec 6, 2016 · 1 comment
Assignees
Labels
documentation release blocking Required feature/issue must be fixed prior to next release.

Comments

@omaray
Copy link
Contributor

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

  • P1: change from Google Cloud Libraries for .NET to Google Cloud .NET Client (for consistency)

Listing Beta client libraries

  • Remove the text "The Google Cloud Libraries for .NET support 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

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. documentation labels Dec 6, 2016
@jskeet
Copy link
Collaborator

jskeet commented Dec 6, 2016

After discussion with Omar:

  • We'll leave the name as it is. We have multiple libraries and no single "big" package, so it makes sense for it to be plural
  • We'll have three pre-release version types: "late beta", "beta" and "alpha", where our "late beta" is like the "beta" above, and "beta" is "we're confident it works, but we expect API churn" vs "alpha" being "pretty experimental - stuff may not work". In future releases we may try to align with the simple alpha/beta, but for the moment these three different levels are useful
  • As we'll now have redundancy between the readme and the docs, we'll have a tool to generate both sections (this may come later)

jskeet added a commit to jskeet/google-cloud-dotnet that referenced this issue Dec 6, 2016
jskeet added a commit to jskeet/google-cloud-dotnet that referenced this issue Dec 6, 2016
jskeet added a commit to jskeet/google-cloud-dotnet that referenced this issue Dec 6, 2016
jskeet added a commit that referenced this issue Dec 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation release blocking Required feature/issue must be fixed prior to next release.
Projects
None yet
Development

No branches or pull requests

2 participants