search

hashicorp / terraform-provider-aws

The AWS Provider enables Terraform to manage AWS resources.
https://registry.terraform.io/providers/hashicorp/aws
Mozilla Public License 2.0
9.74k stars 9.1k forks source link

Website appears to be ahead of the latest planned release #2017

Closed hashibot closed 6 years ago

hashibot commented 6 years ago

This issue was originally opened by @kevinburkeotto as hashicorp/terraform#16428. It was migrated here as a result of the provider split. The original body of the issue is below.

If I am reading the sources correctly, the current Terraform tip for terraform-provider-aws points at this commit: https://github.com/terraform-providers/terraform-provider-aws/commit/669207b8fee698ccc3fc47a7b99f812078b7ef87 (from here: https://github.com/hashicorp/terraform/blob/master/vendor/vendor.json#L1991)

However, the website points at a much more recent commit (the stable-website branch of terraform-provider-aws), and displays text on the website referring to features that I am pretty sure are not included in the latest Terraform release, or Terraform master. In particular I'm interested in the NLB (network load balancer) support. That appears to be in the "stable-website" branch and I can see text related to it on the website, but the code for it doesn't appear to be in the Terraform tool.

There's a sort of a problem where you want the documentation to show two different things, the latest stable release and then also show docs for people on tip. At least on the Go team we resolved this by serving tip documentation at tip.golang.org and the documentation for the latest stable release at golang.org.

https://github.com/hashicorp/terraform-website/blob/master/.gitmodules#L16 https://github.com/terraform-providers/terraform-provider-aws/commits/stable-website?after=cd334ce7237aa3dca4193377a1e2cbe9e988487f+139

apparentlymart commented 6 years ago

Hi @kevinburkeotto,

In general the stable-website branch, and thus the docs shown on the website, points to the commit from the latest release tag. However, sometimes typos and other errors are corrected between releases and so these changes get cherry-picked onto the stable-website branch so they can be deployed without waiting for a full release. (For docs for the current master branch, we currently suggest using Github's rendering of the markdown files that the site is built from.)

Comparing the v1.1.0 tag with stable-website I see only the following extra commits on the latter:

$ git log v1.1.0..origin/stable-website
commit cd334ce7237aa3dca4193377a1e2cbe9e988487f
Author: Radek Simko <radek.simko@gmail.com>
Date:   Mon Oct 16 11:25:01 2017 +0100

    docs: Add missing link to d/s3_bucket

commit 69f2aceefff9892190faf36d89adf1a644fad57c
Author: Radek Simko <radek.simko@gmail.com>
Date:   Mon Oct 16 10:57:16 2017 +0100

    docs: Fix broken link to LBs

From your description I'm not sure specifically which content seems erroneous to you. Network load balancer support was added in #1806 and this was included in version 1.1.0 on Oct 16, so it's expected that this would be reflected on the website currently. If there's something specific about the load balancer page that seems incorrect or misleading, please let me know!

ghost commented 4 years ago

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!