chore: Fixes markdown sections (#2165)

* update markdown headers * revert changelog files
mongodb · Apr 17, 2024 · 78c807d · 78c807d
1 parent 4580a37
commit 78c807d
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/contributing/atlas-sdk.md b/contributing/atlas-sdk.md
@@ -1,7 +1,9 @@
+# Atlas SDK update
+
 Most of the new features of the provider are using [atlas-sdk](https://github.com/mongodb/atlas-sdk-go)
 SDK is updated automatically, tracking all new Atlas features.
 
-### Updating Atlas SDK 
+## How to update Atlas SDK 
 
 To update Atlas SDK run:
 
@@ -13,7 +15,7 @@ make update-atlas-sdk
 
 > NOTE: Command can make import changes to +500 files. Please make sure that you perform update on main branch without any uncommited changes.
 
-### SDK Major Release Update Procedure
+## SDK Major Release Update Procedure
 
 1. If the SDK update doesn’t cause any compilation issues create a new SDK update PR
    1. Review [API Changelog](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog) for any deprecated fields and breaking changes.

diff --git a/contributing/development-best-practices.md b/contributing/development-best-practices.md
@@ -1,5 +1,5 @@
 
-## Development Best Practices
+# Development Best Practices
 
 ## Table of Contents
 - [Creating New Resource and Data Sources](#creating-new-resources-and-data-sources)

diff --git a/contributing/development-setup.md b/contributing/development-setup.md
@@ -1,4 +1,4 @@
-## Development Setup
+# Development Setup
 
 ## Table of Contents
 - [Prerequisite Tools](#prerequisite-tools)

diff --git a/contributing/documentation.md b/contributing/documentation.md
@@ -1,12 +1,12 @@
-## Documentation
+# Documentation
 
 - In our documentation, when a resource field allows a maximum of only one item, we do not format that field as an array. Instead, we create a subsection specifically for this field. Within this new subsection, we enumerate all the attributes of the field. Let's illustrate this with an example: [cloud_backup_schedule.html.markdown](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/website/docs/r/cloud_backup_schedule.html.markdown?plain=1#L207)
 - You can check how the documentation is rendered on the Terraform Registry via [doc-preview](https://registry.terraform.io/tools/doc-preview).
 
-### Creating Resource and Data source Documentation
+## Creating Resource and Data source Documentation
 We autogenerate the documentation of our provider resources and data sources via [tfplugindocs](https://github.com/hashicorp/terraform-plugin-docs).
 
-#### How to generate the documentation for a resource
+### How to generate the documentation for a resource
 - Make sure that the resource and data source schemas have defined the fields `MarkdownDescription` and `Description`.
   - We recommend to use [Scaffolding Schema and Model Definitions](#scaffolding-schema-and-model-definitions) to autogenerate the schema via the Open API specification.
 - Add the resource/data source templates to the [templates](templates) folder. See [README.md](templates/README.md) for more info.

diff --git a/examples/mongodbatlas_alert_configuration/README.md b/examples/mongodbatlas_alert_configuration/README.md
@@ -1,3 +1,5 @@
+# Example - Alert Configuration
+
 ## Using the data source
 Example exists in `alert-configurations-data.tf`. To use this example exactly:
 - Copy directory to local disk