Skip to content

Commit 787faf1

Browse files
authored
chore: Adds example links in resource documentation pages (#3632)
1 parent b4e50d6 commit 787faf1

File tree

66 files changed

+239
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+239
-8
lines changed

docs/resources/access_list_api_key.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ resource "mongodbatlas_access_list_api_key" "test" {
3232
}
3333
```
3434

35+
### Further Examples
36+
- [Create Programmatic API Key](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_api_key)
37+
3538
## Argument Reference
3639

3740
* `org_id` - (Required) Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

docs/resources/advanced_cluster.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,16 @@ Refer to the following for full privatelink endpoint connection string examples:
450450
* [AWS, Private Endpoint](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_privatelink_endpoint/aws/cluster)
451451
* [AWS, Regionalized Private Endpoints](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded)
452452

453+
454+
### Further Examples
455+
- [Asymmetric Sharded Cluster](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster)
456+
- [Auto-Scaling Per Shard](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard)
457+
- [Global Cluster](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_advanced_cluster/global-cluster)
458+
- [Multi-Cloud](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_advanced_cluster/multi-cloud)
459+
- [Tenant Upgrade](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_advanced_cluster/tenant-upgrade)
460+
- [Version Upgrade with Pinned FCV](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_advanced_cluster/version-upgrade-with-pinned-fcv)
461+
- [Migrate Cluster to Advanced Cluster](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/migrate_cluster_to_advanced_cluster/basic)
462+
453463
## Argument Reference
454464

455465
* `project_id` - (Required) Unique ID for the project to create the cluster.

docs/resources/alert_configuration.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ resource "mongodbatlas_alert_configuration" "test" {
132132
}
133133
```
134134

135+
### Further Examples
136+
- [Alert Configuration](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_alert_configuration)
137+
138+
135139
## Argument Reference
136140

137141
* `project_id` - (Required) The ID of the project where the alert configuration will create.

docs/resources/api_key.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ resource "mongodbatlas_api_key" "test" {
1414
}
1515
```
1616

17+
### Further Examples
18+
- [Create Programmatic API Key](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_api_key)
19+
1720
## Argument Reference
1821

1922
* `org_id` - Unique identifier for the organization whose API keys you want to retrieve. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.

docs/resources/api_key_project_assignment.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ resource "mongodbatlas_access_list_api_key" "this" {
4141
}
4242
```
4343

44+
### Further Examples
45+
- [Assign API Key to Project](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_api_key_assignment)
46+
4447
<!-- schema generated by tfplugindocs -->
4548
## Schema
4649

docs/resources/backup_compliance_policy.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,9 @@ resource "mongodbatlas_backup_compliance_policy" "backup_policy" {
132132
}
133133
```
134134

135+
### Further Examples
136+
- [Backup Compliance Policy](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_backup_compliance_policy/resource)
137+
135138
## Argument Reference
136139

137140
* `project_id` - (Required) Unique 24-hexadecimal digit string that identifies your project.

docs/resources/cloud_backup_schedule.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,11 @@ resource "mongodbatlas_cloud_backup_schedule" "test" {
212212
213213
}
214214
```
215+
216+
217+
### Further Examples
218+
- [Cloud Backup Schedule](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_cloud_backup_schedule)
219+
215220
## Argument Reference
216221

217222
* `project_id` - (Required) The unique identifier of the project for the Atlas cluster.

docs/resources/cloud_backup_snapshot.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ resource "mongodbatlas_cloud_backup_snapshot_restore_job" "test" {
5050
}
5151
```
5252

53+
### Further Examples
54+
- [Restore from backup snapshot at point in time](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_cloud_backup_snapshot_restore_job/point-in-time)
55+
- [Restore from backup snapshot using an advanced cluster resource](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_cloud_backup_snapshot_restore_job/point-in-time-advanced-cluster)
56+
5357
## Argument Reference
5458

5559
* `project_id` - (Required) The unique identifier of the project for the Atlas cluster.

docs/resources/cloud_backup_snapshot_export_bucket.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ resource "mongodbatlas_cloud_backup_snapshot_export_bucket" "test" {
3333
}
3434
```
3535

36+
### Further Examples
37+
- [AWS Cloud Backup Snapshot Export Bucket](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_cloud_backup_snapshot_export_bucket/aws)
38+
- [Azure Cloud Backup Snapshot Export Bucket](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_cloud_backup_snapshot_export_bucket/azure)
39+
3640
## Argument Reference
3741

3842
* `project_id` - (Required) The unique identifier of the project for the Atlas cluster.

docs/resources/cloud_backup_snapshot_export_job.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ resource "mongodbatlas_cloud_backup_schedule" "backup" {
8181
}
8282
```
8383

84+
### Further Examples
85+
- [Cloud Backup Snapshot Export Job](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/mongodbatlas_cloud_backup_snapshot_export_job)
86+
8487
## Argument Reference
8588

8689
* `project_id` - (Required) Unique 24-hexadecimal digit string that identifies the project which contains the Atlas cluster whose snapshot you want to export.

0 commit comments

Comments
 (0)