Skip to content

Commit

Permalink
docs: remove gopath and specify min go version constraint (#182)
Browse files Browse the repository at this point in the history
* docs: remove gopath

since the project is already go modules based, there is no need to have reference for gopath

Signed-off-by: Rui Chen <[email protected]>

* build: needs 1.18+

```
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/iterator.go:3:17: syntax error: unexpected any, expecting ]
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/iterator.go:8:19: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/iterator.go:12:19: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:10:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:29:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:53:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:70:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:95:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:106:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:117:12: syntax error: unexpected [, expecting comma or )
../../.asdf/installs/golang/1.17.13/packages/pkg/mod/github.com/zclconf/[email protected]/cty/set/ops.go:117:12: too many errors
note: module requires Go 1.18
```

Signed-off-by: Rui Chen <[email protected]>

---------

Signed-off-by: Rui Chen <[email protected]>
  • Loading branch information
chenrui333 authored Jun 9, 2023
1 parent 92e2f63 commit 5fdbfb6
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 12 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Requirements
* [Terraform](https://www.terraform.io/downloads.html) > 0.12.x
* [Go](https://golang.org/doc/install) 1.17
* [Go](https://golang.org/doc/install) 1.18

Check out the [Terraform Documentation](https://www.terraform.io/docs/configuration/index.html) and their [Introduction](https://www.terraform.io/intro/index.html) for more information on terraform

Expand All @@ -16,8 +16,6 @@ You may find prebuilt binaries in our [Releases](https://github.com/signalscienc

If you wish to build from source, first make the correct directory, cd to it, and checkout the repo. Running `make build` will then build the provider and output it to terraform-provider-sigsci
```shell script
mkdir -p $GOPATH/src/github.com/signalsciences/
cd $GOPATH/src/github.com/signalsciences/
git clone [email protected]:signalsciences/terraform-provider-sigsci.git
cd terraform-provider-sigsci
make build
Expand Down
8 changes: 3 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,20 @@
page_title: "sigsci Provider"
subcategory: ""
description: |-
---

## Requirements
* [Terraform](https://www.terraform.io/downloads.html) 0.12.x, 0.13.x
* [Go](https://golang.org/doc/install) 1.14
* [Go](https://golang.org/doc/install) 1.18

## Building the provider
Build with make and the resulting binary will be terraform-provider-sigsci.

First make the correct directory, cd to it, and checkout the repo. make build will then build the provider and output it to terraform-provider-sigsci
```shell script
mkdir -p $GOPATH/src/github.com/signalsciences/terraform-provider-sigsci
cd $GOPATH/src/github.com/signalsciences/terraform-provider-sigsci
git clone [email protected]:signalsciences/terraform-provider-sigsci.git
make build
cd terraform-provider-sigsci && make build
```

# sigsci Provider
Expand Down
6 changes: 2 additions & 4 deletions templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@ description: |-

## Requirements
* [Terraform](https://www.terraform.io/downloads.html) 0.12.x, 0.13.x
* [Go](https://golang.org/doc/install) 1.14
* [Go](https://golang.org/doc/install) 1.18

## Building the provider
Build with make and the resulting binary will be terraform-provider-sigsci.

First make the correct directory, cd to it, and checkout the repo. make build will then build the provider and output it to terraform-provider-sigsci
```shell script
mkdir -p $GOPATH/src/github.com/signalsciences/terraform-provider-sigsci
cd $GOPATH/src/github.com/signalsciences/terraform-provider-sigsci
git clone [email protected]:signalsciences/terraform-provider-sigsci.git
make build
cd terraform-provider-sigsci && make build
```

# {{.ProviderShortName}} Provider
Expand Down

0 comments on commit 5fdbfb6

Please sign in to comment.