Skip to content

Commit 5b173d1

Browse files
committed
docs: Updated the generator docs.
1 parent 02db190 commit 5b173d1

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

generator/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ After that, search the project for `@TODO` and make the appropriate changes. Exc
1717
## Checklist
1818

1919
* [ ] Generate the stub files.
20+
* [ ] In the new `examples/data-sources/*/data-source.tf` file, ensure the example is implemented correctly.
21+
* [ ] In the new `examples/data-sources/*/terraform-plan.example` file, copy content or delete.
22+
* [ ] In the new `templates/data-sources/*.tmpl` file, update the template that will be used by the `tfplugindocs` package.
23+
* [ ] Generate the Terraform provider documentation.
2024
* [ ] In the new `*_data_source.go` file, update the `*SourceModel` struct.
2125
* [ ] In the new `*_data_source.go` file, update the Schema Attributes to match the `*SourceModel` struct.
2226
* [ ] In the new `*_data_source.go` file, implement the remainder of the `Read` function.
2327
* [ ] In the new test fixture file, implement the test cases.
2428
* [ ] In the new `*_data_source_fixture.tftpl` file, ensure the fixture is implemented correctly.
2529
* [ ] In the new `*_data_source_test.go` file, ensure the test references the fixture correctly.
2630
* [ ] Run the integration tests.
27-
* [ ] In the new `examples/data-sources/*/data-source.tf` file, ensure the example is implemented correctly.
28-
* [ ] In the new `examples/data-sources/*/terraform-plan.example` file, copy content or delete.
29-
* [ ] In the new `templates/data-sources/*.tmpl` file, update the template that will be used by the `tfplugindocs` package.
30-
* [ ] Generate the Terraform provider documentation.
3131
* [ ] Run `tfschema data show -format=json DATASOURCE | jq -Mrc '.attributes[]'`.
3232
* [ ] In the new `bats/*.bats.sh` file, update its contents to match the `tfschema` output.
3333
* [ ] Run the bats tests.

generator/main.go

+2-3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ func main() {
3333
panic(err)
3434
}
3535

36+
fmt.Println("")
37+
fmt.Println("Add " + varMap["PascalStrip"] + "DataSource" + " to " + getAbs("../corefuncprovider/provider.go"))
3638
fmt.Println("")
3739

3840
// ../bats
@@ -97,9 +99,6 @@ func main() {
9799
getAbs("./examples/versions.tftpl"),
98100
getAbs(edsPath+"/versions.tftpl"),
99101
)
100-
101-
fmt.Println("")
102-
fmt.Println("Add " + varMap["PascalStrip"] + "DataSource" + " to " + getAbs("../corefuncprovider/provider.go"))
103102
}
104103

105104
func getAbs(path string) string {

0 commit comments

Comments
 (0)