chore: Add code explanation in some long-running operations (#3390)

* document project_ip_access_list Create

* no need to wait in network_container Delete

* Revert "no need to wait in network_container Delete"

This reverts commit 1e4224f.

* document network_container Delete

* remove timeouts attribute in mongodbatlas_privatelink_endpoint_service_data_federation_online_archive

* Revert "remove timeouts attribute in mongodbatlas_privatelink_endpoint_service_data_federation_online_archive"

This reverts commit bff9dc0.

* comment timeouts in mongodbatlas_privatelink_endpoint_service_data_federation_online_archive

Author: lantoli

internal/service/networkcontainer/resource_network_container.go

@@ -336,6 +336,7 @@ func resourceRefreshFunc(ctx context.Context, d *schema.ResourceData, client *ad
 			return nil, "provisioned_container", nil
 		}
 
+		// Atlas Delete is called inside refresh to retry when error: HTTP 409 Conflict (Error code: "CONTAINERS_IN_USE").
 		_, err = client.NetworkPeeringApi.DeletePeeringContainer(ctx, projectID, containerID).Execute()
 		if err != nil {
 			return nil, "provisioned_container", nil

internal/service/privatelinkendpointservicedatafederationonlinearchive/resource_privatelink_endpoint_service_data_federation_online_archive.go

@@ -70,6 +70,7 @@ func Resource() *schema.Resource {
 				Computed: true,
 			},
 		},
+		// Timeouts are not being used but kept to avoid breaking changes.
 		Timeouts: &schema.ResourceTimeout{
 			Create: schema.DefaultTimeout(2 * time.Hour),
 			Delete: schema.DefaultTimeout(2 * time.Hour),

internal/service/projectipaccesslist/resource_project_ip_access_list.go

@@ -69,6 +69,7 @@ func (r *projectIPAccessListRS) Create(ctx context.Context, req resource.CreateR
 		Target:  []string{"created", "failed"},
 		Refresh: func() (any, string, error) {
 			_, _, err := connV2.ProjectIPAccessListApi.CreateProjectIpAccessList(ctx, projectID, NewMongoDBProjectIPAccessList(projectIPAccessListModel)).Execute()
+			// Atlas Create is called inside refresh because this limitation: This endpoint doesn't support concurrent POST requests. You must submit multiple POST requests synchronously.
 			if err != nil {
 				if strings.Contains(err.Error(), "Unexpected error") ||
 					strings.Contains(err.Error(), "UNEXPECTED_ERROR") ||