From 4e3144c362c08efee67c1f6edb5ff0e3a66efa92 Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Tue, 16 Jul 2024 20:30:41 +0200 Subject: [PATCH] doc: Updates to new Terraform doc structure (#2425) * move to root doc folder * rename ds and resource folders * change file extension to .md * update doc links * gitignore * releasing instructions * git hook * codeowners * workflow template * gha workflows * scripts * remove website-lint * update references to html.markdown * fix compatibility script matrix * rename rest of files * fix generate doc script using docs-out folder to temporary generate all files and copying only to docs folder the specified resource files * fix typo --- .githooks/pre-commit | 6 ---- .github/CODEOWNERS | 3 +- .github/ISSUE_TEMPLATE/Bug_Report.md | 2 +- .github/workflows/check-migration-guide.yml | 2 +- .github/workflows/code-health.yml | 12 +------- .github/workflows/notify-docs-team.yml | 2 +- .github/workflows/release.yml | 4 +-- .gitignore | 6 ---- GNUmakefile | 10 ++----- README.md | 2 +- RELEASING.md | 10 ++----- contributing/documentation.md | 2 +- .../data-sources/access_list_api_key.md | 0 .../data-sources/access_list_api_keys.md | 0 .../data-sources/advanced_cluster.md | 0 .../data-sources/advanced_clusters.md | 0 .../data-sources/alert_configuration.md | 0 .../data-sources/alert_configurations.md | 0 .../data-sources/api_key.md | 0 .../data-sources/api_keys.md | 0 .../data-sources/atlas_user.md | 0 .../data-sources/atlas_users.md | 0 .../data-sources/auditing.md | 0 .../data-sources/backup_compliance_policy.md | 0 .../data-sources/cloud_backup_schedule.md | 0 .../data-sources/cloud_backup_snapshot.md | 0 .../cloud_backup_snapshot_export_bucket.md | 0 .../cloud_backup_snapshot_export_buckets.md | 0 .../cloud_backup_snapshot_export_job.md | 0 .../cloud_backup_snapshot_export_jobs.md | 0 .../cloud_backup_snapshot_restore_job.md | 0 .../cloud_backup_snapshot_restore_jobs.md | 0 .../data-sources/cloud_backup_snapshots.md | 0 .../cloud_provider_access_setup.md | 0 .../cloud_provider_shared_tier_restore_job.md | 0 ...cloud_provider_shared_tier_restore_jobs.md | 0 .../cloud_provider_shared_tier_snapshot.md | 0 .../cloud_provider_shared_tier_snapshots.md | 0 .../data-sources/cloud_provider_snapshot.md | 0 .../cloud_provider_snapshot_backup_policy.md | 0 .../cloud_provider_snapshot_restore_job.md | 0 .../cloud_provider_snapshot_restore_jobs.md | 0 .../data-sources/cloud_provider_snapshots.md | 0 .../data-sources/cluster.md | 0 .../data-sources/cluster_outage_simulation.md | 0 .../data-sources/clusters.md | 0 .../control_plane_ip_addresses.md | 2 +- .../data-sources/custom_db_role.md | 0 .../data-sources/custom_db_roles.md | 0 .../custom_dns_configuration_cluster_aws.md | 0 .../data-sources/data_lake_pipeline.md | 0 .../data-sources/data_lake_pipeline_run.md | 0 .../data-sources/data_lake_pipeline_runs.md | 0 .../data-sources/data_lake_pipelines.md | 0 .../data-sources/database_user.md | 0 .../data-sources/database_users.md | 0 .../data-sources/event_trigger.md | 0 .../data-sources/event_triggers.md | 0 .../federated_database_instance.md | 0 .../federated_database_instances.md | 0 .../data-sources/federated_query_limit.md | 0 .../data-sources/federated_query_limits.md | 0 .../data-sources/federated_settings.md | 0 .../federated_settings_identity_provider.md | 0 .../federated_settings_identity_providers.md | 0 .../federated_settings_org_config.md | 0 .../federated_settings_org_configs.md | 0 .../federated_settings_org_role_mapping.md | 0 .../federated_settings_org_role_mappings.md | 0 .../data-sources/global_cluster_config.md | 0 .../data-sources/ldap_configuration.md | 0 .../data-sources/ldap_verify.md | 0 .../data-sources/maintenance_window.md | 0 .../data-sources/network_container.md | 0 .../data-sources/network_containers.md | 0 .../data-sources/network_peering.md | 0 .../data-sources/network_peerings.md | 0 .../data-sources/online_archive.md | 0 .../data-sources/online_archives.md | 0 .../data-sources/org_invitation.md | 0 .../data-sources/organization.md | 0 .../data-sources/organizations.md | 0 .../private_endpoint_regional_mode.md | 0 .../data-sources/privatelink_endpoint.md | 0 .../privatelink_endpoint_service.md | 0 ..._service_data_federation_online_archive.md | 0 ...service_data_federation_online_archives.md | 0 ...privatelink_endpoint_service_serverless.md | 0 .../privatelink_endpoints_service_adl.md | 0 ...rivatelink_endpoints_service_serverless.md | 0 .../data-sources/project.md | 0 .../data-sources/project_api_key.md | 0 .../data-sources/project_api_keys.md | 0 .../data-sources/project_invitation.md | 0 .../data-sources/project_ip_access_list.md | 0 .../data-sources/projects.md | 0 .../data-sources/push_based_log_export.md | 4 +++ .../data-sources/roles_org_id.md | 0 .../data-sources/search_deployment.md | 0 .../data-sources/search_index.md | 0 .../data-sources/search_indexes.md | 0 .../data-sources/serverless_instance.md | 0 .../data-sources/serverless_instances.md | 0 .../data-sources/stream_connection.md | 0 .../data-sources/stream_connections.md | 0 .../data-sources/stream_instance.md | 0 .../data-sources/stream_instances.md | 0 .../data-sources/team.md | 0 .../data-sources/teams.md | 0 .../data-sources/third_party_integration.md | 0 .../data-sources/third_party_integrations.md | 0 .../x509_authentication_database_user.md | 0 .../guides/0.6.0-upgrade-guide.md | 0 .../guides/0.8.0-upgrade-guide.md | 0 .../guides/0.8.2-upgrade-guide.md | 0 .../guides/0.9.0-upgrade-guide.md | 0 .../guides/0.9.1-upgrade-guide.md | 0 .../guides/1.0.0-upgrade-guide.md | 0 .../guides/1.0.1-upgrade-guide.md | 0 .../guides/1.1.0-upgrade-guide.md | 0 .../guides/1.10.0-upgrade-guide.md | 0 .../guides/1.11.0-upgrade-guide.md | 0 .../guides/1.12.0-upgrade-guide.md | 0 .../guides/1.13.0-upgrade-guide.md | 0 .../guides/1.14.0-upgrade-guide.md | 0 .../guides/1.15.0-upgrade-guide.md | 0 .../guides/1.16.0-upgrade-guide.md | 0 .../guides/1.17.0-upgrade-guide.md | 0 .../guides/1.2.0-upgrade-guide.md | 0 .../guides/1.3.0-upgrade-guide.md | 0 .../guides/1.4.0-upgrade-guide.md | 0 .../guides/1.5.0-upgrade-guide.md | 0 .../guides/1.6.0-upgrade-guide.md | 0 .../guides/1.7.0-upgrade-guide.md | 4 +-- .../guides/1.8.0-upgrade-guide.md | 0 .../guides/1.9.0-upgrade-guide.md | 0 ...ogrammatic-API-Key-upgrade-guide-1.10.0.md | 0 .../docs/index.html.markdown => docs/index.md | 0 .../resources/access_list_api_key.md | 0 .../resources/advanced_cluster.md | 0 .../resources/alert_configuration.md | 0 .../resources/api_key.md | 0 .../resources/auditing.md | 0 .../resources/backup_compliance_policy.md | 0 .../resources/cloud_backup_schedule.md | 0 .../resources/cloud_backup_snapshot.md | 0 .../cloud_backup_snapshot_export_bucket.md | 0 .../cloud_backup_snapshot_export_job.md | 0 .../cloud_backup_snapshot_restore_job.md | 0 .../resources/cloud_provider_access.md | 0 .../resources/cloud_provider_snapshot.md | 0 .../cloud_provider_snapshot_backup_policy.md | 0 .../cloud_provider_snapshot_restore_job.md | 0 .../resources/cluster.md | 0 .../resources/cluster_outage_simulation.md | 0 .../resources/custom_db_role.md | 0 .../custom_dns_configuration_cluster_aws.md | 0 .../resources/data_lake_pipeline.md | 0 .../resources/database_user.md | 0 .../resources/encryption_at_rest.md | 0 .../resources/event_trigger.md | 0 .../resources/federated_database_instance.md | 0 .../resources/federated_query_limit.md | 0 .../federated_settings_identity_provider.md | 0 .../federated_settings_org_config.md | 0 .../federated_settings_org_role_mapping.md | 0 .../resources/global_cluster_config.md | 0 .../resources/ldap_configuration.md | 2 +- .../resources/ldap_verify.md | 0 .../resources/maintenance_window.md | 0 .../resources/network_container.md | 0 .../resources/network_peering.md | 0 .../resources/online_archive.md | 0 .../resources/org_invitation.md | 0 .../resources/organization.md | 0 .../private_endpoint_regional_mode.md | 0 .../resources/privatelink_endpoint.md | 0 .../privatelink_endpoint_serverless.md | 0 .../resources/privatelink_endpoint_service.md | 0 ..._service_data_federation_online_archive.md | 0 ...privatelink_endpoint_service_serverless.md | 0 .../resources/project.md | 0 .../resources/project_api_key.md | 0 .../resources/project_invitation.md | 0 .../resources/project_ip_access_list.md | 0 .../resources/push_based_log_export.md | 11 ++++++- .../resources/search_deployment.md | 0 .../resources/search_index.md | 0 .../resources/serverless_instance.md | 0 .../resources/stream_connection.md | 0 .../resources/stream_instance.md | 0 .../resources/team.md | 0 .../resources/teams.md | 0 .../resources/third_party_integration.md | 0 .../x509_authentication_database_user.md | 0 .../troubleshooting.md | 0 .../global-cluster/README.md | 2 +- .../multi-cloud/README.md | 2 +- .../aws/atlas-cluster/README.md | 2 +- .../aws/multi-region-cluster/README.MD | 2 +- scripts/check-upgrade-guide-exists.sh | 2 +- scripts/generate-doc.sh | 30 ++++++++----------- scripts/update-examples-reference-in-docs.sh | 2 +- scripts/update-tf-compatibility-matrix.sh | 2 +- templates/data-source.md.tmpl | 2 -- .../control_plane_ip_addresses.md.tmpl | 3 +- .../push_based_log_export.md.tmpl | 3 +- .../data-sources/search_deployment.md.tmpl | 3 +- templates/resources.md.tmpl | 2 -- .../resources/push_based_log_export.md.tmpl | 3 +- templates/resources/search_deployment.md.tmpl | 3 +- 211 files changed, 56 insertions(+), 91 deletions(-) rename website/docs/d/access_list_api_key.html.markdown => docs/data-sources/access_list_api_key.md (100%) rename website/docs/d/access_list_api_keys.html.markdown => docs/data-sources/access_list_api_keys.md (100%) rename website/docs/d/advanced_cluster.html.markdown => docs/data-sources/advanced_cluster.md (100%) rename website/docs/d/advanced_clusters.html.markdown => docs/data-sources/advanced_clusters.md (100%) rename website/docs/d/alert_configuration.html.markdown => docs/data-sources/alert_configuration.md (100%) rename website/docs/d/alert_configurations.html.markdown => docs/data-sources/alert_configurations.md (100%) rename website/docs/d/api_key.html.markdown => docs/data-sources/api_key.md (100%) rename website/docs/d/api_keys.html.markdown => docs/data-sources/api_keys.md (100%) rename website/docs/d/atlas_user.html.markdown => docs/data-sources/atlas_user.md (100%) rename website/docs/d/atlas_users.html.markdown => docs/data-sources/atlas_users.md (100%) rename website/docs/d/auditing.html.markdown => docs/data-sources/auditing.md (100%) rename website/docs/d/backup_compliance_policy.html.markdown => docs/data-sources/backup_compliance_policy.md (100%) rename website/docs/d/cloud_backup_schedule.html.markdown => docs/data-sources/cloud_backup_schedule.md (100%) rename website/docs/d/cloud_backup_snapshot.html.markdown => docs/data-sources/cloud_backup_snapshot.md (100%) rename website/docs/d/cloud_backup_snapshot_export_bucket.html.markdown => docs/data-sources/cloud_backup_snapshot_export_bucket.md (100%) rename website/docs/d/cloud_backup_snapshot_export_buckets.html.markdown => docs/data-sources/cloud_backup_snapshot_export_buckets.md (100%) rename website/docs/d/cloud_backup_snapshot_export_job.html.markdown => docs/data-sources/cloud_backup_snapshot_export_job.md (100%) rename website/docs/d/cloud_backup_snapshot_export_jobs.html.markdown => docs/data-sources/cloud_backup_snapshot_export_jobs.md (100%) rename website/docs/d/cloud_backup_snapshot_restore_job.html.markdown => docs/data-sources/cloud_backup_snapshot_restore_job.md (100%) rename website/docs/d/cloud_backup_snapshot_restore_jobs.html.markdown => docs/data-sources/cloud_backup_snapshot_restore_jobs.md (100%) rename website/docs/d/cloud_backup_snapshots.html.markdown => docs/data-sources/cloud_backup_snapshots.md (100%) rename website/docs/d/cloud_provider_access_setup.markdown => docs/data-sources/cloud_provider_access_setup.md (100%) rename website/docs/d/cloud_provider_shared_tier_restore_job.html.markdown => docs/data-sources/cloud_provider_shared_tier_restore_job.md (100%) rename website/docs/d/cloud_provider_shared_tier_restore_jobs.html.markdown => docs/data-sources/cloud_provider_shared_tier_restore_jobs.md (100%) rename website/docs/d/cloud_provider_shared_tier_snapshot.html.markdown => docs/data-sources/cloud_provider_shared_tier_snapshot.md (100%) rename website/docs/d/cloud_provider_shared_tier_snapshots.html.markdown => docs/data-sources/cloud_provider_shared_tier_snapshots.md (100%) rename website/docs/d/cloud_provider_snapshot.html.markdown => docs/data-sources/cloud_provider_snapshot.md (100%) rename website/docs/d/cloud_provider_snapshot_backup_policy.html.markdown => docs/data-sources/cloud_provider_snapshot_backup_policy.md (100%) rename website/docs/d/cloud_provider_snapshot_restore_job.html.markdown => docs/data-sources/cloud_provider_snapshot_restore_job.md (100%) rename website/docs/d/cloud_provider_snapshot_restore_jobs.html.markdown => docs/data-sources/cloud_provider_snapshot_restore_jobs.md (100%) rename website/docs/d/cloud_provider_snapshots.html.markdown => docs/data-sources/cloud_provider_snapshots.md (100%) rename website/docs/d/cluster.html.markdown => docs/data-sources/cluster.md (100%) rename website/docs/d/cluster_outage_simulation.html.markdown => docs/data-sources/cluster_outage_simulation.md (100%) rename website/docs/d/clusters.html.markdown => docs/data-sources/clusters.md (100%) rename website/docs/d/control_plane_ip_addresses.html.markdown => docs/data-sources/control_plane_ip_addresses.md (95%) rename website/docs/d/custom_db_role.html.markdown => docs/data-sources/custom_db_role.md (100%) rename website/docs/d/custom_db_roles.html.markdown => docs/data-sources/custom_db_roles.md (100%) rename website/docs/d/custom_dns_configuration_cluster_aws.html.markdown => docs/data-sources/custom_dns_configuration_cluster_aws.md (100%) rename website/docs/d/data_lake_pipeline.html.markdown => docs/data-sources/data_lake_pipeline.md (100%) rename website/docs/d/data_lake_pipeline_run.html.markdown => docs/data-sources/data_lake_pipeline_run.md (100%) rename website/docs/d/data_lake_pipeline_runs.html.markdown => docs/data-sources/data_lake_pipeline_runs.md (100%) rename website/docs/d/data_lake_pipelines.html.markdown => docs/data-sources/data_lake_pipelines.md (100%) rename website/docs/d/database_user.html.markdown => docs/data-sources/database_user.md (100%) rename website/docs/d/database_users.html.markdown => docs/data-sources/database_users.md (100%) rename website/docs/d/event_trigger.html.markdown => docs/data-sources/event_trigger.md (100%) rename website/docs/d/event_triggers.html.markdown => docs/data-sources/event_triggers.md (100%) rename website/docs/d/federated_database_instance.html.markdown => docs/data-sources/federated_database_instance.md (100%) rename website/docs/d/federated_database_instances.html.markdown => docs/data-sources/federated_database_instances.md (100%) rename website/docs/d/federated_query_limit.html.markdown => docs/data-sources/federated_query_limit.md (100%) rename website/docs/d/federated_query_limits.html.markdown => docs/data-sources/federated_query_limits.md (100%) rename website/docs/d/federated_settings.html.markdown => docs/data-sources/federated_settings.md (100%) rename website/docs/d/federated_settings_identity_provider.html.markdown => docs/data-sources/federated_settings_identity_provider.md (100%) rename website/docs/d/federated_settings_identity_providers.html.markdown => docs/data-sources/federated_settings_identity_providers.md (100%) rename website/docs/d/federated_settings_org_config.html.markdown => docs/data-sources/federated_settings_org_config.md (100%) rename website/docs/d/federated_settings_org_configs.html.markdown => docs/data-sources/federated_settings_org_configs.md (100%) rename website/docs/d/federated_settings_org_role_mapping.html.markdown => docs/data-sources/federated_settings_org_role_mapping.md (100%) rename website/docs/d/federated_settings_org_role_mappings.html.markdown => docs/data-sources/federated_settings_org_role_mappings.md (100%) rename website/docs/d/global_cluster_config.html.markdown => docs/data-sources/global_cluster_config.md (100%) rename website/docs/d/ldap_configuration.html.markdown => docs/data-sources/ldap_configuration.md (100%) rename website/docs/d/ldap_verify.html.markdown => docs/data-sources/ldap_verify.md (100%) rename website/docs/d/maintenance_window.html.markdown => docs/data-sources/maintenance_window.md (100%) rename website/docs/d/network_container.html.markdown => docs/data-sources/network_container.md (100%) rename website/docs/d/network_containers.html.markdown => docs/data-sources/network_containers.md (100%) rename website/docs/d/network_peering.html.markdown => docs/data-sources/network_peering.md (100%) rename website/docs/d/network_peerings.html.markdown => docs/data-sources/network_peerings.md (100%) rename website/docs/d/online_archive.html.markdown => docs/data-sources/online_archive.md (100%) rename website/docs/d/online_archives.html.markdown => docs/data-sources/online_archives.md (100%) rename website/docs/d/org_invitation.html.markdown => docs/data-sources/org_invitation.md (100%) rename website/docs/d/organization.html.markdown => docs/data-sources/organization.md (100%) rename website/docs/d/organizations.html.markdown => docs/data-sources/organizations.md (100%) rename website/docs/d/private_endpoint_regional_mode.html.markdown => docs/data-sources/private_endpoint_regional_mode.md (100%) rename website/docs/d/privatelink_endpoint.html.markdown => docs/data-sources/privatelink_endpoint.md (100%) rename website/docs/d/privatelink_endpoint_service.html.markdown => docs/data-sources/privatelink_endpoint_service.md (100%) rename website/docs/d/privatelink_endpoint_service_data_federation_online_archive.html.markdown => docs/data-sources/privatelink_endpoint_service_data_federation_online_archive.md (100%) rename website/docs/d/privatelink_endpoint_service_data_federation_online_archives.html.markdown => docs/data-sources/privatelink_endpoint_service_data_federation_online_archives.md (100%) rename website/docs/d/privatelink_endpoint_service_serverless.html.markdown => docs/data-sources/privatelink_endpoint_service_serverless.md (100%) rename website/docs/d/privatelink_endpoints_service_adl.html.markdown => docs/data-sources/privatelink_endpoints_service_adl.md (100%) rename website/docs/d/privatelink_endpoints_service_serverless.html.markdown => docs/data-sources/privatelink_endpoints_service_serverless.md (100%) rename website/docs/d/project.html.markdown => docs/data-sources/project.md (100%) rename website/docs/d/project_api_key.html.markdown => docs/data-sources/project_api_key.md (100%) rename website/docs/d/project_api_keys.html.markdown => docs/data-sources/project_api_keys.md (100%) rename website/docs/d/project_invitation.html.markdown => docs/data-sources/project_invitation.md (100%) rename website/docs/d/project_ip_access_list.html.markdown => docs/data-sources/project_ip_access_list.md (100%) rename website/docs/d/projects.html.markdown => docs/data-sources/projects.md (100%) rename website/docs/d/push_based_log_export.html.markdown => docs/data-sources/push_based_log_export.md (96%) rename website/docs/d/roles_org_id.html.markdown => docs/data-sources/roles_org_id.md (100%) rename website/docs/d/search_deployment.html.markdown => docs/data-sources/search_deployment.md (100%) rename website/docs/d/search_index.html.markdown => docs/data-sources/search_index.md (100%) rename website/docs/d/search_indexes.html.markdown => docs/data-sources/search_indexes.md (100%) rename website/docs/d/serverless_instance.html.markdown => docs/data-sources/serverless_instance.md (100%) rename website/docs/d/serverless_instances.html.markdown => docs/data-sources/serverless_instances.md (100%) rename website/docs/d/stream_connection.html.markdown => docs/data-sources/stream_connection.md (100%) rename website/docs/d/stream_connections.html.markdown => docs/data-sources/stream_connections.md (100%) rename website/docs/d/stream_instance.html.markdown => docs/data-sources/stream_instance.md (100%) rename website/docs/d/stream_instances.html.markdown => docs/data-sources/stream_instances.md (100%) rename website/docs/d/team.html.markdown => docs/data-sources/team.md (100%) rename website/docs/d/teams.html.markdown => docs/data-sources/teams.md (100%) rename website/docs/d/third_party_integration.markdown => docs/data-sources/third_party_integration.md (100%) rename website/docs/d/third_party_integrations.markdown => docs/data-sources/third_party_integrations.md (100%) rename website/docs/d/x509_authentication_database_user.html.markdown => docs/data-sources/x509_authentication_database_user.md (100%) rename website/docs/guides/0.6.0-upgrade-guide.html.markdown => docs/guides/0.6.0-upgrade-guide.md (100%) rename website/docs/guides/0.8.0-upgrade-guide.html.markdown => docs/guides/0.8.0-upgrade-guide.md (100%) rename website/docs/guides/0.8.2-upgrade-guide.html.markdown => docs/guides/0.8.2-upgrade-guide.md (100%) rename website/docs/guides/0.9.0-upgrade-guide.html.markdown => docs/guides/0.9.0-upgrade-guide.md (100%) rename website/docs/guides/0.9.1-upgrade-guide.html.markdown => docs/guides/0.9.1-upgrade-guide.md (100%) rename website/docs/guides/1.0.0-upgrade-guide.html.markdown => docs/guides/1.0.0-upgrade-guide.md (100%) rename website/docs/guides/1.0.1-upgrade-guide.html.markdown => docs/guides/1.0.1-upgrade-guide.md (100%) rename website/docs/guides/1.1.0-upgrade-guide.html.markdown => docs/guides/1.1.0-upgrade-guide.md (100%) rename website/docs/guides/1.10.0-upgrade-guide.html.markdown => docs/guides/1.10.0-upgrade-guide.md (100%) rename website/docs/guides/1.11.0-upgrade-guide.html.markdown => docs/guides/1.11.0-upgrade-guide.md (100%) rename website/docs/guides/1.12.0-upgrade-guide.html.markdown => docs/guides/1.12.0-upgrade-guide.md (100%) rename website/docs/guides/1.13.0-upgrade-guide.html.markdown => docs/guides/1.13.0-upgrade-guide.md (100%) rename website/docs/guides/1.14.0-upgrade-guide.html.markdown => docs/guides/1.14.0-upgrade-guide.md (100%) rename website/docs/guides/1.15.0-upgrade-guide.html.markdown => docs/guides/1.15.0-upgrade-guide.md (100%) rename website/docs/guides/1.16.0-upgrade-guide.html.markdown => docs/guides/1.16.0-upgrade-guide.md (100%) rename website/docs/guides/1.17.0-upgrade-guide.html.markdown => docs/guides/1.17.0-upgrade-guide.md (100%) rename website/docs/guides/1.2.0-upgrade-guide.html.markdown => docs/guides/1.2.0-upgrade-guide.md (100%) rename website/docs/guides/1.3.0-upgrade-guide.html.markdown => docs/guides/1.3.0-upgrade-guide.md (100%) rename website/docs/guides/1.4.0-upgrade-guide.html.markdown => docs/guides/1.4.0-upgrade-guide.md (100%) rename website/docs/guides/1.5.0-upgrade-guide.html.markdown => docs/guides/1.5.0-upgrade-guide.md (100%) rename website/docs/guides/1.6.0-upgrade-guide.html.markdown => docs/guides/1.6.0-upgrade-guide.md (100%) rename website/docs/guides/1.7.0-upgrade-guide.html.markdown => docs/guides/1.7.0-upgrade-guide.md (92%) rename website/docs/guides/1.8.0-upgrade-guide.html.markdown => docs/guides/1.8.0-upgrade-guide.md (100%) rename website/docs/guides/1.9.0-upgrade-guide.html.markdown => docs/guides/1.9.0-upgrade-guide.md (100%) rename website/docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.html.markdown => docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.md (100%) rename website/docs/index.html.markdown => docs/index.md (100%) rename website/docs/r/access_list_api_key.html.markdown => docs/resources/access_list_api_key.md (100%) rename website/docs/r/advanced_cluster.html.markdown => docs/resources/advanced_cluster.md (100%) rename website/docs/r/alert_configuration.html.markdown => docs/resources/alert_configuration.md (100%) rename website/docs/r/api_key.html.markdown => docs/resources/api_key.md (100%) rename website/docs/r/auditing.html.markdown => docs/resources/auditing.md (100%) rename website/docs/r/backup_compliance_policy.html.markdown => docs/resources/backup_compliance_policy.md (100%) rename website/docs/r/cloud_backup_schedule.html.markdown => docs/resources/cloud_backup_schedule.md (100%) rename website/docs/r/cloud_backup_snapshot.html.markdown => docs/resources/cloud_backup_snapshot.md (100%) rename website/docs/r/cloud_backup_snapshot_export_bucket.html.markdown => docs/resources/cloud_backup_snapshot_export_bucket.md (100%) rename website/docs/r/cloud_backup_snapshot_export_job.html.markdown => docs/resources/cloud_backup_snapshot_export_job.md (100%) rename website/docs/r/cloud_backup_snapshot_restore_job.html.markdown => docs/resources/cloud_backup_snapshot_restore_job.md (100%) rename website/docs/r/cloud_provider_access.markdown => docs/resources/cloud_provider_access.md (100%) rename website/docs/r/cloud_provider_snapshot.html.markdown => docs/resources/cloud_provider_snapshot.md (100%) rename website/docs/r/cloud_provider_snapshot_backup_policy.html.markdown => docs/resources/cloud_provider_snapshot_backup_policy.md (100%) rename website/docs/r/cloud_provider_snapshot_restore_job.html.markdown => docs/resources/cloud_provider_snapshot_restore_job.md (100%) rename website/docs/r/cluster.html.markdown => docs/resources/cluster.md (100%) rename website/docs/r/cluster_outage_simulation.html.markdown => docs/resources/cluster_outage_simulation.md (100%) rename website/docs/r/custom_db_role.html.markdown => docs/resources/custom_db_role.md (100%) rename website/docs/r/custom_dns_configuration_cluster_aws.markdown => docs/resources/custom_dns_configuration_cluster_aws.md (100%) rename website/docs/r/data_lake_pipeline.html.markdown => docs/resources/data_lake_pipeline.md (100%) rename website/docs/r/database_user.html.markdown => docs/resources/database_user.md (100%) rename website/docs/r/encryption_at_rest.html.markdown => docs/resources/encryption_at_rest.md (100%) rename website/docs/r/event_trigger.html.markdown => docs/resources/event_trigger.md (100%) rename website/docs/r/federated_database_instance.html.markdown => docs/resources/federated_database_instance.md (100%) rename website/docs/r/federated_query_limit.html.markdown => docs/resources/federated_query_limit.md (100%) rename website/docs/r/federated_settings_identity_provider.html.markdown => docs/resources/federated_settings_identity_provider.md (100%) rename website/docs/r/federated_settings_org_config.html.markdown => docs/resources/federated_settings_org_config.md (100%) rename website/docs/r/federated_settings_org_role_mapping.html.markdown => docs/resources/federated_settings_org_role_mapping.md (100%) rename website/docs/r/global_cluster_config.html.markdown => docs/resources/global_cluster_config.md (100%) rename website/docs/r/ldap_configuration.html.markdown => docs/resources/ldap_configuration.md (93%) rename website/docs/r/ldap_verify.html.markdown => docs/resources/ldap_verify.md (100%) rename website/docs/r/maintenance_window.html.markdown => docs/resources/maintenance_window.md (100%) rename website/docs/r/network_container.html.markdown => docs/resources/network_container.md (100%) rename website/docs/r/network_peering.html.markdown => docs/resources/network_peering.md (100%) rename website/docs/r/online_archive.html.markdown => docs/resources/online_archive.md (100%) rename website/docs/r/org_invitation.html.markdown => docs/resources/org_invitation.md (100%) rename website/docs/r/organization.html.markdown => docs/resources/organization.md (100%) rename website/docs/r/private_endpoint_regional_mode.html.markdown => docs/resources/private_endpoint_regional_mode.md (100%) rename website/docs/r/privatelink_endpoint.html.markdown => docs/resources/privatelink_endpoint.md (100%) rename website/docs/r/privatelink_endpoint_serverless.html.markdown => docs/resources/privatelink_endpoint_serverless.md (100%) rename website/docs/r/privatelink_endpoint_service.html.markdown => docs/resources/privatelink_endpoint_service.md (100%) rename website/docs/r/privatelink_endpoint_service_data_federation_online_archive.html.markdown => docs/resources/privatelink_endpoint_service_data_federation_online_archive.md (100%) rename website/docs/r/privatelink_endpoint_service_serverless.html.markdown => docs/resources/privatelink_endpoint_service_serverless.md (100%) rename website/docs/r/project.html.markdown => docs/resources/project.md (100%) rename website/docs/r/project_api_key.html.markdown => docs/resources/project_api_key.md (100%) rename website/docs/r/project_invitation.html.markdown => docs/resources/project_invitation.md (100%) rename website/docs/r/project_ip_access_list.html.markdown => docs/resources/project_ip_access_list.md (100%) rename website/docs/r/push_based_log_export.html.markdown => docs/resources/push_based_log_export.md (94%) rename website/docs/r/search_deployment.html.markdown => docs/resources/search_deployment.md (100%) rename website/docs/r/search_index.html.markdown => docs/resources/search_index.md (100%) rename website/docs/r/serverless_instance.html.markdown => docs/resources/serverless_instance.md (100%) rename website/docs/r/stream_connection.html.markdown => docs/resources/stream_connection.md (100%) rename website/docs/r/stream_instance.html.markdown => docs/resources/stream_instance.md (100%) rename website/docs/r/team.html.markdown => docs/resources/team.md (100%) rename website/docs/r/teams.html.markdown => docs/resources/teams.md (100%) rename website/docs/r/third_party_integration.markdown => docs/resources/third_party_integration.md (100%) rename website/docs/r/x509_authentication_database_user.html.markdown => docs/resources/x509_authentication_database_user.md (100%) rename website/docs/troubleshooting.html.markdown => docs/troubleshooting.md (100%) diff --git a/.githooks/pre-commit b/.githooks/pre-commit index 44f4adf85a..56888b51ce 100755 --- a/.githooks/pre-commit +++ b/.githooks/pre-commit @@ -26,9 +26,3 @@ if [ -n "$STAGED_TF_FILES" ]; then echo "Checking the format of Terraform files" make tflint fi - -STAGED_WEBSITES_FILES=$(git diff --cached --name-only | grep "website/") -if [ -n "$STAGED_WEBSITES_FILES" ]; then - echo "Checking the format of website files" - make website-lint -fi diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 6a9258efdb..7690854475 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,7 +1,6 @@ # Maintained by the MongoDB APIx-Integrations team * @mongodb/APIx-Integrations - # Changelog entries reviewed by Docs Cloud Team /.changelog/ @mongodb/docs-cloud-team -/website/ @mongodb/docs-cloud-team +/docs/ @mongodb/docs-cloud-team diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md index d165962905..367d472c18 100644 --- a/.github/ISSUE_TEMPLATE/Bug_Report.md +++ b/.github/ISSUE_TEMPLATE/Bug_Report.md @@ -19,7 +19,7 @@ Our support will prioritise issues that contain all the required information tha ### Terraform CLI and Terraform MongoDB Atlas Provider Version -Please ensure your issue is reproducible on a supported Terraform version. You may review our [Terraform version compatibility matrix](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/index.html.markdown#hashicorp-terraform-version-compatibility-matrix) to know more. +Please ensure your issue is reproducible on a supported Terraform version. You may review our [Terraform version compatibility matrix](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#hashicorp-terraform-version-compatibility-matrix) to know more. diff --git a/website/docs/d/roles_org_id.html.markdown b/docs/data-sources/roles_org_id.md similarity index 100% rename from website/docs/d/roles_org_id.html.markdown rename to docs/data-sources/roles_org_id.md diff --git a/website/docs/d/search_deployment.html.markdown b/docs/data-sources/search_deployment.md similarity index 100% rename from website/docs/d/search_deployment.html.markdown rename to docs/data-sources/search_deployment.md diff --git a/website/docs/d/search_index.html.markdown b/docs/data-sources/search_index.md similarity index 100% rename from website/docs/d/search_index.html.markdown rename to docs/data-sources/search_index.md diff --git a/website/docs/d/search_indexes.html.markdown b/docs/data-sources/search_indexes.md similarity index 100% rename from website/docs/d/search_indexes.html.markdown rename to docs/data-sources/search_indexes.md diff --git a/website/docs/d/serverless_instance.html.markdown b/docs/data-sources/serverless_instance.md similarity index 100% rename from website/docs/d/serverless_instance.html.markdown rename to docs/data-sources/serverless_instance.md diff --git a/website/docs/d/serverless_instances.html.markdown b/docs/data-sources/serverless_instances.md similarity index 100% rename from website/docs/d/serverless_instances.html.markdown rename to docs/data-sources/serverless_instances.md diff --git a/website/docs/d/stream_connection.html.markdown b/docs/data-sources/stream_connection.md similarity index 100% rename from website/docs/d/stream_connection.html.markdown rename to docs/data-sources/stream_connection.md diff --git a/website/docs/d/stream_connections.html.markdown b/docs/data-sources/stream_connections.md similarity index 100% rename from website/docs/d/stream_connections.html.markdown rename to docs/data-sources/stream_connections.md diff --git a/website/docs/d/stream_instance.html.markdown b/docs/data-sources/stream_instance.md similarity index 100% rename from website/docs/d/stream_instance.html.markdown rename to docs/data-sources/stream_instance.md diff --git a/website/docs/d/stream_instances.html.markdown b/docs/data-sources/stream_instances.md similarity index 100% rename from website/docs/d/stream_instances.html.markdown rename to docs/data-sources/stream_instances.md diff --git a/website/docs/d/team.html.markdown b/docs/data-sources/team.md similarity index 100% rename from website/docs/d/team.html.markdown rename to docs/data-sources/team.md diff --git a/website/docs/d/teams.html.markdown b/docs/data-sources/teams.md similarity index 100% rename from website/docs/d/teams.html.markdown rename to docs/data-sources/teams.md diff --git a/website/docs/d/third_party_integration.markdown b/docs/data-sources/third_party_integration.md similarity index 100% rename from website/docs/d/third_party_integration.markdown rename to docs/data-sources/third_party_integration.md diff --git a/website/docs/d/third_party_integrations.markdown b/docs/data-sources/third_party_integrations.md similarity index 100% rename from website/docs/d/third_party_integrations.markdown rename to docs/data-sources/third_party_integrations.md diff --git a/website/docs/d/x509_authentication_database_user.html.markdown b/docs/data-sources/x509_authentication_database_user.md similarity index 100% rename from website/docs/d/x509_authentication_database_user.html.markdown rename to docs/data-sources/x509_authentication_database_user.md diff --git a/website/docs/guides/0.6.0-upgrade-guide.html.markdown b/docs/guides/0.6.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/0.6.0-upgrade-guide.html.markdown rename to docs/guides/0.6.0-upgrade-guide.md diff --git a/website/docs/guides/0.8.0-upgrade-guide.html.markdown b/docs/guides/0.8.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/0.8.0-upgrade-guide.html.markdown rename to docs/guides/0.8.0-upgrade-guide.md diff --git a/website/docs/guides/0.8.2-upgrade-guide.html.markdown b/docs/guides/0.8.2-upgrade-guide.md similarity index 100% rename from website/docs/guides/0.8.2-upgrade-guide.html.markdown rename to docs/guides/0.8.2-upgrade-guide.md diff --git a/website/docs/guides/0.9.0-upgrade-guide.html.markdown b/docs/guides/0.9.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/0.9.0-upgrade-guide.html.markdown rename to docs/guides/0.9.0-upgrade-guide.md diff --git a/website/docs/guides/0.9.1-upgrade-guide.html.markdown b/docs/guides/0.9.1-upgrade-guide.md similarity index 100% rename from website/docs/guides/0.9.1-upgrade-guide.html.markdown rename to docs/guides/0.9.1-upgrade-guide.md diff --git a/website/docs/guides/1.0.0-upgrade-guide.html.markdown b/docs/guides/1.0.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.0.0-upgrade-guide.html.markdown rename to docs/guides/1.0.0-upgrade-guide.md diff --git a/website/docs/guides/1.0.1-upgrade-guide.html.markdown b/docs/guides/1.0.1-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.0.1-upgrade-guide.html.markdown rename to docs/guides/1.0.1-upgrade-guide.md diff --git a/website/docs/guides/1.1.0-upgrade-guide.html.markdown b/docs/guides/1.1.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.1.0-upgrade-guide.html.markdown rename to docs/guides/1.1.0-upgrade-guide.md diff --git a/website/docs/guides/1.10.0-upgrade-guide.html.markdown b/docs/guides/1.10.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.10.0-upgrade-guide.html.markdown rename to docs/guides/1.10.0-upgrade-guide.md diff --git a/website/docs/guides/1.11.0-upgrade-guide.html.markdown b/docs/guides/1.11.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.11.0-upgrade-guide.html.markdown rename to docs/guides/1.11.0-upgrade-guide.md diff --git a/website/docs/guides/1.12.0-upgrade-guide.html.markdown b/docs/guides/1.12.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.12.0-upgrade-guide.html.markdown rename to docs/guides/1.12.0-upgrade-guide.md diff --git a/website/docs/guides/1.13.0-upgrade-guide.html.markdown b/docs/guides/1.13.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.13.0-upgrade-guide.html.markdown rename to docs/guides/1.13.0-upgrade-guide.md diff --git a/website/docs/guides/1.14.0-upgrade-guide.html.markdown b/docs/guides/1.14.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.14.0-upgrade-guide.html.markdown rename to docs/guides/1.14.0-upgrade-guide.md diff --git a/website/docs/guides/1.15.0-upgrade-guide.html.markdown b/docs/guides/1.15.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.15.0-upgrade-guide.html.markdown rename to docs/guides/1.15.0-upgrade-guide.md diff --git a/website/docs/guides/1.16.0-upgrade-guide.html.markdown b/docs/guides/1.16.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.16.0-upgrade-guide.html.markdown rename to docs/guides/1.16.0-upgrade-guide.md diff --git a/website/docs/guides/1.17.0-upgrade-guide.html.markdown b/docs/guides/1.17.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.17.0-upgrade-guide.html.markdown rename to docs/guides/1.17.0-upgrade-guide.md diff --git a/website/docs/guides/1.2.0-upgrade-guide.html.markdown b/docs/guides/1.2.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.2.0-upgrade-guide.html.markdown rename to docs/guides/1.2.0-upgrade-guide.md diff --git a/website/docs/guides/1.3.0-upgrade-guide.html.markdown b/docs/guides/1.3.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.3.0-upgrade-guide.html.markdown rename to docs/guides/1.3.0-upgrade-guide.md diff --git a/website/docs/guides/1.4.0-upgrade-guide.html.markdown b/docs/guides/1.4.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.4.0-upgrade-guide.html.markdown rename to docs/guides/1.4.0-upgrade-guide.md diff --git a/website/docs/guides/1.5.0-upgrade-guide.html.markdown b/docs/guides/1.5.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.5.0-upgrade-guide.html.markdown rename to docs/guides/1.5.0-upgrade-guide.md diff --git a/website/docs/guides/1.6.0-upgrade-guide.html.markdown b/docs/guides/1.6.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.6.0-upgrade-guide.html.markdown rename to docs/guides/1.6.0-upgrade-guide.md diff --git a/website/docs/guides/1.7.0-upgrade-guide.html.markdown b/docs/guides/1.7.0-upgrade-guide.md similarity index 92% rename from website/docs/guides/1.7.0-upgrade-guide.html.markdown rename to docs/guides/1.7.0-upgrade-guide.md index f29a56002c..ee9988f593 100644 --- a/website/docs/guides/1.7.0-upgrade-guide.html.markdown +++ b/docs/guides/1.7.0-upgrade-guide.md @@ -8,12 +8,10 @@ subcategory: "Older Guides" The Terraform MongoDB Atlas Provider version 1.7.0 has one main new and exciting feature. New Features: -* You can now [`authenticate with AWS Secrets Manager (AWS SM)`](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/index.html.markdown#aws-secrets-manager) - +* You can now [`authenticate with AWS Secrets Manager (AWS SM)`](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager) See the [CHANGELOG](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/CHANGELOG.md) for more details. - ### Helpful Links * [Report bugs](https://github.com/mongodb/terraform-provider-mongodbatlas/issues) diff --git a/website/docs/guides/1.8.0-upgrade-guide.html.markdown b/docs/guides/1.8.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.8.0-upgrade-guide.html.markdown rename to docs/guides/1.8.0-upgrade-guide.md diff --git a/website/docs/guides/1.9.0-upgrade-guide.html.markdown b/docs/guides/1.9.0-upgrade-guide.md similarity index 100% rename from website/docs/guides/1.9.0-upgrade-guide.html.markdown rename to docs/guides/1.9.0-upgrade-guide.md diff --git a/website/docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.html.markdown b/docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.md similarity index 100% rename from website/docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.html.markdown rename to docs/guides/Programmatic-API-Key-upgrade-guide-1.10.0.md diff --git a/website/docs/index.html.markdown b/docs/index.md similarity index 100% rename from website/docs/index.html.markdown rename to docs/index.md diff --git a/website/docs/r/access_list_api_key.html.markdown b/docs/resources/access_list_api_key.md similarity index 100% rename from website/docs/r/access_list_api_key.html.markdown rename to docs/resources/access_list_api_key.md diff --git a/website/docs/r/advanced_cluster.html.markdown b/docs/resources/advanced_cluster.md similarity index 100% rename from website/docs/r/advanced_cluster.html.markdown rename to docs/resources/advanced_cluster.md diff --git a/website/docs/r/alert_configuration.html.markdown b/docs/resources/alert_configuration.md similarity index 100% rename from website/docs/r/alert_configuration.html.markdown rename to docs/resources/alert_configuration.md diff --git a/website/docs/r/api_key.html.markdown b/docs/resources/api_key.md similarity index 100% rename from website/docs/r/api_key.html.markdown rename to docs/resources/api_key.md diff --git a/website/docs/r/auditing.html.markdown b/docs/resources/auditing.md similarity index 100% rename from website/docs/r/auditing.html.markdown rename to docs/resources/auditing.md diff --git a/website/docs/r/backup_compliance_policy.html.markdown b/docs/resources/backup_compliance_policy.md similarity index 100% rename from website/docs/r/backup_compliance_policy.html.markdown rename to docs/resources/backup_compliance_policy.md diff --git a/website/docs/r/cloud_backup_schedule.html.markdown b/docs/resources/cloud_backup_schedule.md similarity index 100% rename from website/docs/r/cloud_backup_schedule.html.markdown rename to docs/resources/cloud_backup_schedule.md diff --git a/website/docs/r/cloud_backup_snapshot.html.markdown b/docs/resources/cloud_backup_snapshot.md similarity index 100% rename from website/docs/r/cloud_backup_snapshot.html.markdown rename to docs/resources/cloud_backup_snapshot.md diff --git a/website/docs/r/cloud_backup_snapshot_export_bucket.html.markdown b/docs/resources/cloud_backup_snapshot_export_bucket.md similarity index 100% rename from website/docs/r/cloud_backup_snapshot_export_bucket.html.markdown rename to docs/resources/cloud_backup_snapshot_export_bucket.md diff --git a/website/docs/r/cloud_backup_snapshot_export_job.html.markdown b/docs/resources/cloud_backup_snapshot_export_job.md similarity index 100% rename from website/docs/r/cloud_backup_snapshot_export_job.html.markdown rename to docs/resources/cloud_backup_snapshot_export_job.md diff --git a/website/docs/r/cloud_backup_snapshot_restore_job.html.markdown b/docs/resources/cloud_backup_snapshot_restore_job.md similarity index 100% rename from website/docs/r/cloud_backup_snapshot_restore_job.html.markdown rename to docs/resources/cloud_backup_snapshot_restore_job.md diff --git a/website/docs/r/cloud_provider_access.markdown b/docs/resources/cloud_provider_access.md similarity index 100% rename from website/docs/r/cloud_provider_access.markdown rename to docs/resources/cloud_provider_access.md diff --git a/website/docs/r/cloud_provider_snapshot.html.markdown b/docs/resources/cloud_provider_snapshot.md similarity index 100% rename from website/docs/r/cloud_provider_snapshot.html.markdown rename to docs/resources/cloud_provider_snapshot.md diff --git a/website/docs/r/cloud_provider_snapshot_backup_policy.html.markdown b/docs/resources/cloud_provider_snapshot_backup_policy.md similarity index 100% rename from website/docs/r/cloud_provider_snapshot_backup_policy.html.markdown rename to docs/resources/cloud_provider_snapshot_backup_policy.md diff --git a/website/docs/r/cloud_provider_snapshot_restore_job.html.markdown b/docs/resources/cloud_provider_snapshot_restore_job.md similarity index 100% rename from website/docs/r/cloud_provider_snapshot_restore_job.html.markdown rename to docs/resources/cloud_provider_snapshot_restore_job.md diff --git a/website/docs/r/cluster.html.markdown b/docs/resources/cluster.md similarity index 100% rename from website/docs/r/cluster.html.markdown rename to docs/resources/cluster.md diff --git a/website/docs/r/cluster_outage_simulation.html.markdown b/docs/resources/cluster_outage_simulation.md similarity index 100% rename from website/docs/r/cluster_outage_simulation.html.markdown rename to docs/resources/cluster_outage_simulation.md diff --git a/website/docs/r/custom_db_role.html.markdown b/docs/resources/custom_db_role.md similarity index 100% rename from website/docs/r/custom_db_role.html.markdown rename to docs/resources/custom_db_role.md diff --git a/website/docs/r/custom_dns_configuration_cluster_aws.markdown b/docs/resources/custom_dns_configuration_cluster_aws.md similarity index 100% rename from website/docs/r/custom_dns_configuration_cluster_aws.markdown rename to docs/resources/custom_dns_configuration_cluster_aws.md diff --git a/website/docs/r/data_lake_pipeline.html.markdown b/docs/resources/data_lake_pipeline.md similarity index 100% rename from website/docs/r/data_lake_pipeline.html.markdown rename to docs/resources/data_lake_pipeline.md diff --git a/website/docs/r/database_user.html.markdown b/docs/resources/database_user.md similarity index 100% rename from website/docs/r/database_user.html.markdown rename to docs/resources/database_user.md diff --git a/website/docs/r/encryption_at_rest.html.markdown b/docs/resources/encryption_at_rest.md similarity index 100% rename from website/docs/r/encryption_at_rest.html.markdown rename to docs/resources/encryption_at_rest.md diff --git a/website/docs/r/event_trigger.html.markdown b/docs/resources/event_trigger.md similarity index 100% rename from website/docs/r/event_trigger.html.markdown rename to docs/resources/event_trigger.md diff --git a/website/docs/r/federated_database_instance.html.markdown b/docs/resources/federated_database_instance.md similarity index 100% rename from website/docs/r/federated_database_instance.html.markdown rename to docs/resources/federated_database_instance.md diff --git a/website/docs/r/federated_query_limit.html.markdown b/docs/resources/federated_query_limit.md similarity index 100% rename from website/docs/r/federated_query_limit.html.markdown rename to docs/resources/federated_query_limit.md diff --git a/website/docs/r/federated_settings_identity_provider.html.markdown b/docs/resources/federated_settings_identity_provider.md similarity index 100% rename from website/docs/r/federated_settings_identity_provider.html.markdown rename to docs/resources/federated_settings_identity_provider.md diff --git a/website/docs/r/federated_settings_org_config.html.markdown b/docs/resources/federated_settings_org_config.md similarity index 100% rename from website/docs/r/federated_settings_org_config.html.markdown rename to docs/resources/federated_settings_org_config.md diff --git a/website/docs/r/federated_settings_org_role_mapping.html.markdown b/docs/resources/federated_settings_org_role_mapping.md similarity index 100% rename from website/docs/r/federated_settings_org_role_mapping.html.markdown rename to docs/resources/federated_settings_org_role_mapping.md diff --git a/website/docs/r/global_cluster_config.html.markdown b/docs/resources/global_cluster_config.md similarity index 100% rename from website/docs/r/global_cluster_config.html.markdown rename to docs/resources/global_cluster_config.md diff --git a/website/docs/r/ldap_configuration.html.markdown b/docs/resources/ldap_configuration.md similarity index 93% rename from website/docs/r/ldap_configuration.html.markdown rename to docs/resources/ldap_configuration.md index f0d6d527df..a6d2642801 100644 --- a/website/docs/r/ldap_configuration.html.markdown +++ b/docs/resources/ldap_configuration.md @@ -1,6 +1,6 @@ # Resource: mongodbatlas_ldap_configuration -`mongodbatlas_ldap_configuration` provides an LDAP Configuration resource. This allows an LDAP configuration for an Atlas project to be crated and managed. This endpoint doesn’t verify connectivity using the provided LDAP over TLS configuration details. To verify a configuration before saving it, use the resource to [verify](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/INTMDB-114/website/docs/r/ldap_verify.html.markdown) the LDAP configuration. +`mongodbatlas_ldap_configuration` provides an LDAP Configuration resource. This allows an LDAP configuration for an Atlas project to be created and managed. This endpoint doesn’t verify connectivity using the provided LDAP over TLS configuration details. To verify a configuration before saving it, use the resource to [verify](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/resources/ldap_verify.md) the LDAP configuration. ## Example Usage diff --git a/website/docs/r/ldap_verify.html.markdown b/docs/resources/ldap_verify.md similarity index 100% rename from website/docs/r/ldap_verify.html.markdown rename to docs/resources/ldap_verify.md diff --git a/website/docs/r/maintenance_window.html.markdown b/docs/resources/maintenance_window.md similarity index 100% rename from website/docs/r/maintenance_window.html.markdown rename to docs/resources/maintenance_window.md diff --git a/website/docs/r/network_container.html.markdown b/docs/resources/network_container.md similarity index 100% rename from website/docs/r/network_container.html.markdown rename to docs/resources/network_container.md diff --git a/website/docs/r/network_peering.html.markdown b/docs/resources/network_peering.md similarity index 100% rename from website/docs/r/network_peering.html.markdown rename to docs/resources/network_peering.md diff --git a/website/docs/r/online_archive.html.markdown b/docs/resources/online_archive.md similarity index 100% rename from website/docs/r/online_archive.html.markdown rename to docs/resources/online_archive.md diff --git a/website/docs/r/org_invitation.html.markdown b/docs/resources/org_invitation.md similarity index 100% rename from website/docs/r/org_invitation.html.markdown rename to docs/resources/org_invitation.md diff --git a/website/docs/r/organization.html.markdown b/docs/resources/organization.md similarity index 100% rename from website/docs/r/organization.html.markdown rename to docs/resources/organization.md diff --git a/website/docs/r/private_endpoint_regional_mode.html.markdown b/docs/resources/private_endpoint_regional_mode.md similarity index 100% rename from website/docs/r/private_endpoint_regional_mode.html.markdown rename to docs/resources/private_endpoint_regional_mode.md diff --git a/website/docs/r/privatelink_endpoint.html.markdown b/docs/resources/privatelink_endpoint.md similarity index 100% rename from website/docs/r/privatelink_endpoint.html.markdown rename to docs/resources/privatelink_endpoint.md diff --git a/website/docs/r/privatelink_endpoint_serverless.html.markdown b/docs/resources/privatelink_endpoint_serverless.md similarity index 100% rename from website/docs/r/privatelink_endpoint_serverless.html.markdown rename to docs/resources/privatelink_endpoint_serverless.md diff --git a/website/docs/r/privatelink_endpoint_service.html.markdown b/docs/resources/privatelink_endpoint_service.md similarity index 100% rename from website/docs/r/privatelink_endpoint_service.html.markdown rename to docs/resources/privatelink_endpoint_service.md diff --git a/website/docs/r/privatelink_endpoint_service_data_federation_online_archive.html.markdown b/docs/resources/privatelink_endpoint_service_data_federation_online_archive.md similarity index 100% rename from website/docs/r/privatelink_endpoint_service_data_federation_online_archive.html.markdown rename to docs/resources/privatelink_endpoint_service_data_federation_online_archive.md diff --git a/website/docs/r/privatelink_endpoint_service_serverless.html.markdown b/docs/resources/privatelink_endpoint_service_serverless.md similarity index 100% rename from website/docs/r/privatelink_endpoint_service_serverless.html.markdown rename to docs/resources/privatelink_endpoint_service_serverless.md diff --git a/website/docs/r/project.html.markdown b/docs/resources/project.md similarity index 100% rename from website/docs/r/project.html.markdown rename to docs/resources/project.md diff --git a/website/docs/r/project_api_key.html.markdown b/docs/resources/project_api_key.md similarity index 100% rename from website/docs/r/project_api_key.html.markdown rename to docs/resources/project_api_key.md diff --git a/website/docs/r/project_invitation.html.markdown b/docs/resources/project_invitation.md similarity index 100% rename from website/docs/r/project_invitation.html.markdown rename to docs/resources/project_invitation.md diff --git a/website/docs/r/project_ip_access_list.html.markdown b/docs/resources/project_ip_access_list.md similarity index 100% rename from website/docs/r/project_ip_access_list.html.markdown rename to docs/resources/project_ip_access_list.md diff --git a/website/docs/r/push_based_log_export.html.markdown b/docs/resources/push_based_log_export.md similarity index 94% rename from website/docs/r/push_based_log_export.html.markdown rename to docs/resources/push_based_log_export.md index 591a0b1d34..5c2f5cb41a 100644 --- a/website/docs/r/push_based_log_export.html.markdown +++ b/docs/resources/push_based_log_export.md @@ -34,6 +34,14 @@ resource "mongodbatlas_push_based_log_export" "test" { iam_role_id = mongodbatlas_cloud_provider_access_authorization.auth_role.role_id prefix_path = "push-based-log-test" } + +data "mongodbatlas_push_based_log_export" "test" { + project_id = mongodbatlas_push_based_log_export.test.project_id +} + +output "test" { + value = data.mongodbatlas_push_based_log_export.test.prefix_path +} ``` @@ -43,12 +51,13 @@ resource "mongodbatlas_push_based_log_export" "test" { - `bucket_name` (String) The name of the bucket to which the agent sends the logs to. - `iam_role_id` (String) ID of the AWS IAM role that is used to write to the S3 bucket. -- `prefix_path` (String) S3 directory in which vector writes in order to store the logs. An empty string denotes the root directory. - `project_id` (String) Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. ### Optional + +- `prefix_path` (String) S3 directory in which vector writes in order to store the logs. An empty string denotes the root directory. - `timeouts` (Attributes) (see [below for nested schema](#nestedatt--timeouts)) ### Read-Only diff --git a/website/docs/r/search_deployment.html.markdown b/docs/resources/search_deployment.md similarity index 100% rename from website/docs/r/search_deployment.html.markdown rename to docs/resources/search_deployment.md diff --git a/website/docs/r/search_index.html.markdown b/docs/resources/search_index.md similarity index 100% rename from website/docs/r/search_index.html.markdown rename to docs/resources/search_index.md diff --git a/website/docs/r/serverless_instance.html.markdown b/docs/resources/serverless_instance.md similarity index 100% rename from website/docs/r/serverless_instance.html.markdown rename to docs/resources/serverless_instance.md diff --git a/website/docs/r/stream_connection.html.markdown b/docs/resources/stream_connection.md similarity index 100% rename from website/docs/r/stream_connection.html.markdown rename to docs/resources/stream_connection.md diff --git a/website/docs/r/stream_instance.html.markdown b/docs/resources/stream_instance.md similarity index 100% rename from website/docs/r/stream_instance.html.markdown rename to docs/resources/stream_instance.md diff --git a/website/docs/r/team.html.markdown b/docs/resources/team.md similarity index 100% rename from website/docs/r/team.html.markdown rename to docs/resources/team.md diff --git a/website/docs/r/teams.html.markdown b/docs/resources/teams.md similarity index 100% rename from website/docs/r/teams.html.markdown rename to docs/resources/teams.md diff --git a/website/docs/r/third_party_integration.markdown b/docs/resources/third_party_integration.md similarity index 100% rename from website/docs/r/third_party_integration.markdown rename to docs/resources/third_party_integration.md diff --git a/website/docs/r/x509_authentication_database_user.html.markdown b/docs/resources/x509_authentication_database_user.md similarity index 100% rename from website/docs/r/x509_authentication_database_user.html.markdown rename to docs/resources/x509_authentication_database_user.md diff --git a/website/docs/troubleshooting.html.markdown b/docs/troubleshooting.md similarity index 100% rename from website/docs/troubleshooting.html.markdown rename to docs/troubleshooting.md diff --git a/examples/mongodbatlas_advanced_cluster/global-cluster/README.md b/examples/mongodbatlas_advanced_cluster/global-cluster/README.md index 71b82915f2..428821a1fe 100644 --- a/examples/mongodbatlas_advanced_cluster/global-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster/global-cluster/README.md @@ -30,7 +30,7 @@ private_key = "" atlas_org_id = "" ``` -... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/index.html.markdown#aws-secrets-manager) +... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager) **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md b/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md index 4b97956416..4e356cb8c9 100644 --- a/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md +++ b/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md @@ -30,7 +30,7 @@ private_key = "" atlas_org_id = "" ``` -... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/index.html.markdown#aws-secrets-manager) +... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager) **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md index b80cd6e205..01b3fc0988 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md +++ b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md @@ -32,7 +32,7 @@ private_key = "22b722a9-34f4-3b1b-aada-298329a5c128" atlas_org_id = "63f4d4a47baeac59406dc131" ``` -... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/index.html.markdown#aws-secrets-manager) +... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager) **2\. Set your AWS access key & secret via environment variables: diff --git a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD index 399938e967..88771e727a 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD +++ b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD @@ -32,7 +32,7 @@ private_key = "22b722a9-34f4-3b1b-aada-298329a5c128" atlas_org_id = "63f4d4a47baeac59406dc131" ``` -... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/index.html.markdown#aws-secrets-manager) +... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager) **2\. Set your AWS access key & secret via environment variables: diff --git a/scripts/check-upgrade-guide-exists.sh b/scripts/check-upgrade-guide-exists.sh index 70c94c82ac..d1cdf7f136 100755 --- a/scripts/check-upgrade-guide-exists.sh +++ b/scripts/check-upgrade-guide-exists.sh @@ -10,7 +10,7 @@ IFS='.' read -r MAJOR MINOR PATCH <<< "$RELEASE_NUMBER" # Check if it's a major release (patch version is 0) if [ "$PATCH" -eq 0 ]; then - UPGRADE_GUIDE_PATH="website/docs/guides/$MAJOR.$MINOR.$PATCH-upgrade-guide.html.markdown" + UPGRADE_GUIDE_PATH="docs/guides/$MAJOR.$MINOR.$PATCH-upgrade-guide.md" echo "Checking for the presence of $UPGRADE_GUIDE_PATH" if [ ! -f "$UPGRADE_GUIDE_PATH" ]; then echo "Stopping release process, upgrade guide $UPGRADE_GUIDE_PATH does not exist. Please visit our docs for more details: https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/RELEASING.md" diff --git a/scripts/generate-doc.sh b/scripts/generate-doc.sh index 9adf5616dd..8e2973e6af 100755 --- a/scripts/generate-doc.sh +++ b/scripts/generate-doc.sh @@ -32,7 +32,7 @@ set -euo pipefail -TF_VERSION="${TF_VERSION:-"1.7"}" # TF version to use when running tfplugindocs. Default: 1.7 +TF_VERSION="${TF_VERSION:-"1.9.2"}" # TF version to use when running tfplugindocs. Default: 1.9.2 TEMPLATE_FOLDER_PATH="${TEMPLATE_FOLDER_PATH:-"templates"}" # PATH to the templates folder. Default: templates @@ -67,39 +67,35 @@ if [ ! -f "${TEMPLATE_FOLDER_PATH}/data-sources/${resource_name}s.md.tmpl" ]; th printf "Skipping this check: We assume that the resource does not have a plural data source.\n\n" fi -# tfplugindocs uses this folder to generate the documentations -mkdir -p docs +tfplugindocs generate --tf-version "${TF_VERSION}" --website-source-dir "${TEMPLATE_FOLDER_PATH}" --rendered-website-dir "docs-out" -tfplugindocs generate --tf-version "${TF_VERSION}" --website-source-dir "${TEMPLATE_FOLDER_PATH}" - -if [ ! -f "docs/resources/${resource_name}.md" ]; then +if [ ! -f "docs-out/resources/${resource_name}.md" ]; then echo "Error: We cannot find the documentation file for the resource ${resource_name}.md" echo "Please, make sure to include the resource template under templates/resources/${resource_name}.md.tmpl" printf "Skipping this step: We assume that only a data source is being generated.\n\n" else - printf "\nMoving the generated file %s.md to the website folder" "${resource_name}" - mv "docs/resources/${resource_name}.md" "website/docs/r/${resource_name}.html.markdown" + printf "Moving the generated resource file %s.md to the website folder.\n" "${resource_name}" + mv "docs-out/resources/${resource_name}.md" "docs/resources/${resource_name}.md" fi -if [ ! -f "docs/data-sources/${resource_name}.md" ]; then +if [ ! -f "docs-out/data-sources/${resource_name}.md" ]; then echo "Error: We cannot find the documentation file for the data source ${resource_name}.md" echo "Please, make sure to include the data source template under templates/data-sources/${resource_name}.md.tmpl" exit 1 else - printf "\nMoving the generated file %s.md to the website folder" "${resource_name}" - mv "docs/data-sources/${resource_name}.md" "website/docs/d/${resource_name}.html.markdown" + printf "Moving the generated data-source file %s.md to the website folder.\n" "${resource_name}" + mv "docs-out/data-sources/${resource_name}.md" "docs/data-sources/${resource_name}.md" fi -if [ ! -f "docs/data-sources/${resource_name}s.md" ]; then - echo "Warning: We cannot find the documentation file for the data source ${resource_name}s.md." +if [ ! -f "docs-out/data-sources/${resource_name}s.md" ]; then + echo "Warning: We cannot find the documentation file for the plural data source ${resource_name}s.md." echo "Please, make sure to include the data source template under templates/data-sources/${resource_name}s.md.tmpl" printf "Skipping this step: We assume that the resource does not have a plural data source.\n\n" else - printf "\nMoving the generated file %s.md to the website folder" "${resource_name}s" - mv "docs/data-sources/${resource_name}s.md" "website/docs/d/${resource_name}s.html.markdown" + printf "\nMoving the generated plural data-source file %s.md to the website folder.\n" "${resource_name}s" + mv "docs-out/data-sources/${resource_name}s.md" "docs/data-sources/${resource_name}s.md" fi -# Delete the docs/ folder -rm -R docs/ +rm -R docs-out/ printf "\nThe documentation for %s has been created.\n" "${resource_name}" diff --git a/scripts/update-examples-reference-in-docs.sh b/scripts/update-examples-reference-in-docs.sh index 2df63f2e12..90ff16ba54 100755 --- a/scripts/update-examples-reference-in-docs.sh +++ b/scripts/update-examples-reference-in-docs.sh @@ -4,7 +4,7 @@ set -euo pipefail : "${1?"Tag of new release must be provided"}" -FILE_PATH="./website/docs/index.html.markdown" +FILE_PATH="./docs/index.md" RELEASE_TAG=$1 # Define the old URL pattern and new URL diff --git a/scripts/update-tf-compatibility-matrix.sh b/scripts/update-tf-compatibility-matrix.sh index 9d9b172a66..8e1925d6a3 100755 --- a/scripts/update-tf-compatibility-matrix.sh +++ b/scripts/update-tf-compatibility-matrix.sh @@ -17,7 +17,7 @@ set -euo pipefail input_array=$(./scripts/get-terraform-supported-versions.sh "true") -indexFile="website/docs/index.html.markdown" +indexFile="docs/index.md" transform_array() { local arr="$1" diff --git a/templates/data-source.md.tmpl b/templates/data-source.md.tmpl index 15038928c2..32b76776d1 100644 --- a/templates/data-source.md.tmpl +++ b/templates/data-source.md.tmpl @@ -1,7 +1,5 @@ # {{ if .Name }}{{.Type}}: {{.Name}}{{ end }} -{{ if .Description }} {{ .Description | trimspace }} {{ end }} - ## Example Usages {{ if .Name }} {{ if eq .Name "mongodbatlas_network_peering" }} diff --git a/templates/data-sources/control_plane_ip_addresses.md.tmpl b/templates/data-sources/control_plane_ip_addresses.md.tmpl index c1e6d6dc51..32993054eb 100644 --- a/templates/data-sources/control_plane_ip_addresses.md.tmpl +++ b/templates/data-sources/control_plane_ip_addresses.md.tmpl @@ -1,7 +1,6 @@ # {{.Type}}: {{.Name}} -{{ .Description | trimspace }} -Provides a data source that returns all control plane IP addresses. +`{{.Name}}` returns all control plane IP addresses. ## Example Usages {{ tffile (printf "examples/%s/main.tf" .Name )}} diff --git a/templates/data-sources/push_based_log_export.md.tmpl b/templates/data-sources/push_based_log_export.md.tmpl index 03255fcd68..0c25f4821c 100644 --- a/templates/data-sources/push_based_log_export.md.tmpl +++ b/templates/data-sources/push_based_log_export.md.tmpl @@ -1,7 +1,6 @@ # {{.Type}}: {{.Name}} -{{ .Description | trimspace }} -`mongodbatlas_push_based_log_export` describes the configured project level settings for the push-based log export feature. +`{{.Name}}` describes the configured project level settings for the push-based log export feature. ## Example Usages {{ tffile (printf "examples/%s/main.tf" .Name )}} diff --git a/templates/data-sources/search_deployment.md.tmpl b/templates/data-sources/search_deployment.md.tmpl index b20f0829e6..b746ea483e 100644 --- a/templates/data-sources/search_deployment.md.tmpl +++ b/templates/data-sources/search_deployment.md.tmpl @@ -1,7 +1,6 @@ # {{.Type}}: {{.Name}} -{{ .Description | trimspace }} -`mongodbatlas_search_deployment` describes a search node deployment. +`{{.Name}}` describes a search node deployment. ## Example Usages {{ tffile (printf "examples/%s/main.tf" .Name )}} diff --git a/templates/resources.md.tmpl b/templates/resources.md.tmpl index d81c9cfb75..8b86768a70 100644 --- a/templates/resources.md.tmpl +++ b/templates/resources.md.tmpl @@ -1,7 +1,5 @@ #{{ if .Name }} {{.Type}}: {{.Name}}{{ end }} -{{ if .Name }}{{ .Description | trimspace }}{{ end }} - ## Example Usages {{ if .Name }} {{ if eq .Name "mongodbatlas_network_peering" }} diff --git a/templates/resources/push_based_log_export.md.tmpl b/templates/resources/push_based_log_export.md.tmpl index ad2634f582..aadfb9d954 100644 --- a/templates/resources/push_based_log_export.md.tmpl +++ b/templates/resources/push_based_log_export.md.tmpl @@ -1,7 +1,6 @@ # {{.Type}}: {{.Name}} -{{ .Description | trimspace }} -`mongodbatlas_push_based_log_export` provides a resource for push-based log export feature. The resource lets you configure, enable & disable the project level settings for the push-based log export feature. Using this resource you +`{{.Name}}` provides a resource for push-based log export feature. The resource lets you configure, enable & disable the project level settings for the push-based log export feature. Using this resource you can continually push logs from mongod, mongos, and audit logs to an Amazon S3 bucket. Atlas exports logs every 5 minutes. diff --git a/templates/resources/search_deployment.md.tmpl b/templates/resources/search_deployment.md.tmpl index 1e503a8982..0b6c72b40f 100644 --- a/templates/resources/search_deployment.md.tmpl +++ b/templates/resources/search_deployment.md.tmpl @@ -1,7 +1,6 @@ # {{.Type}}: {{.Name}} -{{ .Description | trimspace }} -`mongodbatlas_search_deployment` provides a Search Deployment resource. The resource lets you create, edit and delete dedicated search nodes in a cluster. +`{{.Name}}` provides a Search Deployment resource. The resource lets you create, edit and delete dedicated search nodes in a cluster. -> **NOTE:** For details on supported cloud providers and existing limitations you can visit the [Search Node Documentation](https://www.mongodb.com/docs/atlas/cluster-config/multi-cloud-distribution/#search-nodes-for-workload-isolation).