Skip to content

Commit

Permalink
Add information about releases to provider docsite (#770)
Browse files Browse the repository at this point in the history
Signed-off-by: Modular Magician <[email protected]>
  • Loading branch information
modular-magician authored and rileykarson committed May 29, 2019
1 parent 15a9f5b commit e76adf1
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 29 deletions.
66 changes: 40 additions & 26 deletions website/docs/index.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,7 @@ provider "google" {
```

See the [provider reference](/docs/providers/google/provider_reference.html)
for more details on authenticating or otherwise configuring the provider.

Interested in the provider's latest features, or want to make sure you're up to date?
Check out the [changelog](https://github.com/terraform-providers/terraform-provider-google/blob/master/CHANGELOG.md)
for version information and release notes.
for more details on authentication or otherwise configuring the provider.

Take advantage of [Modules](https://www.terraform.io/docs/modules/index.html)
to simplify your config by browsing the [Module Registry for GCP modules](https://registry.terraform.io/browse?provider=google).
Expand All @@ -44,6 +40,39 @@ If you have configuration questions, or general questions about using the provid
* [Terraform's community resources](https://www.terraform.io/docs/extend/community/index.html)
* [HashiCorp support](https://support.hashicorp.com) for Terraform Enterprise customers

## Releases

Interested in the provider's latest features, or want to make sure you're up to date?
Check out the [`google` provider changelog](https://github.com/terraform-providers/terraform-provider-google/blob/master/CHANGELOG.md)
and the [`google-beta` provider changelog](https://github.com/terraform-providers/terraform-provider-google-beta/blob/master/CHANGELOG.md))
for release notes and additional information.

Per [Terraform Provider Versioning](https://www.hashicorp.com/blog/hashicorp-terraform-provider-versioning),
the Google provider follows [semantic versioning](https://semver.org/).

In practice, patch / bugfix-only releases of the provider are infrequent. Most
provider releases are either minor or major releases.

### Minor Releases

The Google provider currently aims to publish a minor release every 2 weeks,
although the timing of individual releases may differ if required by the
provider team.

### Major Releases

The Google provider publishes major releases roughly yearly. An upgrade guide
will be published to help ease you through the transition between the prior
releases series and the new major release.

During major releases, all current deprecation warnings will be resolved,
removing the field in question unless the deprecation warning message specifies
another resolution.

Before a major release, deprecation warnings don't require immediate action. The
provider team aims to surface deprecation warnings early in a major release
lifecycle to give users plenty of time to safely update their configs.

## Features and Bug Requests

The Google provider's bugs and feature requests can be found in the [GitHub repo issues](https://github.com/terraform-providers/terraform-provider-google/issues).
Expand All @@ -67,31 +96,16 @@ who is working on it.
* An issue assigned to an individual maintainer indicates that maintainer is working
on the issue
* An issue assigned to the `modular-magician` indicates the feature is being
autogenerated by [Magic Modules](https://github.com/GoogleCloudPlatform/magic-modules)
generated by [Magic Modules](https://github.com/GoogleCloudPlatform/magic-modules)
in the immediate future, so direct contributions to that resource are discouraged.
* An issue assigned to `hashibot` indicates a member of the community has taken on
the issue!

## Contributing

If you'd like to help extend the Google provider, we gladly accept community
contributions! Pull requests should be made against [Magic Modules](https://github.com/GoogleCloudPlatform/magic-modules)
to ensure they are applied to both `google` and `google-beta`.

Check out the [Magic Modules setup guide](https://github.com/GoogleCloudPlatform/magic-modules#one-time-setup) to get set up, the [provider README](https://github.com/terraform-providers/terraform-provider-google)
for instructions about running your generated code, the [HashiCorp contribution guidelines](https://github.com/hashicorp/terraform/blob/master/.github/CONTRIBUTING.md)
for a Terraform provider development overview, and the [Google provider contribution guidelines](https://github.com/terraform-providers/terraform-provider-google/blob/master/.github/CONTRIBUTING.md)
for our provider-specific advice.

## GCP API Versions

The Google provider supports generally available (GA) and Beta GCP features. We
are focusing on filling out general GA feature coverage and on adding support
for beta features that customers request. If you need us to support a feature
whether GA or beta, please [file a feature request](https://github.com/terraform-providers/terraform-provider-google/issues/new?template=enhancement.md)!

If you're interested in using Alpha GCP features, you should still [file a feature request](https://github.com/terraform-providers/terraform-provider-google/issues/new?template=enhancement.md)
or thumbs up [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
the existing request if one exists. By filing and reacting to requests, we can
gauge your interest in yet-to-be-supported GCP features and make sure that we
prioritize support for them when they enter Beta.
contributions! Our full contribution guide is available at [CONTRIBUTING.md](https://github.com/terraform-providers/terraform-provider-google/blob/master/.github/CONTRIBUTING.md)

Pull requests can be made against either provider repo where a maintainer will
apply them to both `google` and `google-beta`, or against [Magic Modules](https://github.com/GoogleCloudPlatform/magic-modules)
directly.
7 changes: 4 additions & 3 deletions website/docs/provider_versions.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ description: |-

# Google Provider Versions

Starting with version `1.19.0`, there are two versions of the Google provider:
Starting with the `1.19.0` release, there are two versions of the Google
provider:

* `google`

Expand All @@ -23,8 +24,8 @@ supports GCP products and features that are in beta, while `google` does not.
Fields and resources that are only present in `google-beta` will be marked as
such in the shared provider documentation.

`1.X` versions of the `google` provider supported beta features; from `2.0.0`
onwards, beta features are only supported in `google-beta`.
`1.X` series releases of the `google` provider supported beta features; from
`2.0.0` onwards, beta features are only supported in `google-beta`.

Beta GCP features have no deprecation policy and no SLA, but are otherwise considered to be feature-complete
with only minor outstanding issues after their Alpha period. Beta is when GCP
Expand Down

0 comments on commit e76adf1

Please sign in to comment.