You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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):
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):
Versioning section
If the Versioning section doesn't exist, add one.
Add the following content in the Versioning section:
The text was updated successfully, but these errors were encountered:
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
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
Google Cloud Libraries for .NET
toGoogle 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):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):Versioning section
If the Versioning section doesn't exist, add one.
Add the following content in the Versioning section:
The text was updated successfully, but these errors were encountered: