Giters

hashicorp / terraform

Terraform enables you to safely and predictably create, change, and improve infrastructure. It is a source-available tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned.

Home Page:https://www.terraform.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

New build process for `go doc` code documentation

crw opened this issue · comments

commented

Terraform Version

n/a

Affected Pages

What is the docs issue?

Before HashiCorp changed core project licensing to the BUSL, the internal Terraform development team relied on the automated docs generation provided gratis by the pkg.go.dev golang package hosting service. Due to the change in license, this service is no longer available as the BUSL license is not compatible with the rules of that hosting service. (Please see golang/go#59183 for the extended reasoning behind their license restrictions.) As a result, the development team can no longer rely on that service, and the architecture.md file that links to those docs now has links that are non-functional.

Proposal

It is not clear to this issue proposer what the best replacement solution should be. One can imagine creating or leveraging a new GitHub Action that runs go doc and outputs to a HashiCorp-managed site such as GitHub pages. The HashiCorp build and release management team may already have a standard solution for this problem, or different ideas on how to implement the correct solution.

References