diff --git a/docs/add-a-new-list-resource.md b/docs/add-a-new-list-resource.md index 3ef6a1237aa5..c2adebbb27c4 100644 --- a/docs/add-a-new-list-resource.md +++ b/docs/add-a-new-list-resource.md @@ -177,9 +177,14 @@ Run the acceptance tests for the new list resource to ensure everything is funct Replace `` and `` with the appropriate service and resource names. ```sh - make testacc PKG= TESTARGS='-run=TestAcc_List_' +make testacc PKG= TESTARGS='-run=TestAcc_List_' ``` +### Create Documentation + +`skaff` will create a stub documentation file. +Ensure that it is accurate and documents any additional attributes on the `list` block. + ## Troubleshooting ### Prerequisites Issues diff --git a/docs/add-a-new-resource.md b/docs/add-a-new-resource.md index e9dc4eb94d66..24ed28d07eb1 100644 --- a/docs/add-a-new-resource.md +++ b/docs/add-a-new-resource.md @@ -98,6 +98,14 @@ You will need at a minimum: Add a file covering the use of the new resource in `website/docs/r/_.md`. Add more examples if it is complex or relies on resources in another service. This documentation will appear on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest) when the resource is made available in a provider release. Link to AWS Documentation where appropriate, particularly for values which are likely to change. +### Add a Corresponding List Resource + +A List Resource is a side-car type that adds a Listing operation to a resource type's Create, Read, Update, and Delete operations. +It is easiest to add after the main CRUD functionality of the resource type is implemented, but should still be part of creating a new resource type. + +See the instructions in the guide [Adding a New List Resource](add-a-new-list-resource.md). +Full details on implementing a List Resource can be found in the [List Resource Reference](list-resources.md). + ### Ensure format and lint checks are passing locally Format your code and check linters to detect various issues.