Skip to content

Commit

Permalink
doc: Updates to new Terraform doc structure (#2425)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
lantoli authored Jul 16, 2024
1 parent fa31ccf commit 4e3144c
Show file tree
Hide file tree
Showing 211 changed files with 56 additions and 91 deletions.
6 changes: 0 additions & 6 deletions .githooks/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 1 addition & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/Bug_Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<!---
Run `terraform version` to show the version, and paste the result for Terraform and the MongoDB Atlas Provider between the ``` marks below.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-migration-guide.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ jobs:
with:
filters: |
guides:
- 'website/docs/guides/**'
- 'docs/guides/**'
- if: ${{ steps.changes.outputs.guides == 'false' }}
run: echo "PR with breaking changes but no migration guide was created or updated" && exit 1
12 changes: 1 addition & 11 deletions .github/workflows/code-health.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,6 @@ jobs:
- name: actionlint
run: make tools && actionlint -verbose -color
shell: bash
website-lint:
runs-on: ubuntu-latest
permissions: {}
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7
with:
go-version-file: 'go.mod'
- name: website lint
run: make tools && make website-lint
shellcheck:
runs-on: ubuntu-latest
permissions: {}
Expand All @@ -71,6 +61,6 @@ jobs:
- name: Run ShellCheck
uses: bewuethr/shellcheck-action@d01912909579c4b1a335828b8fca197fbb8e0aa4
call-acceptance-tests-workflow:
needs: [build, lint, shellcheck, unit-test, website-lint]
needs: [build, lint, shellcheck, unit-test]
secrets: inherit
uses: ./.github/workflows/acceptance-tests.yml
2 changes: 1 addition & 1 deletion .github/workflows/notify-docs-team.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
filters: |
files:
- '.changelog/**'
- 'website/**'
- 'docs/**'
slack-notification:
needs: check
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ jobs:
uses: ./.github/workflows/run-script-and-commit.yml
with:
script_call: './scripts/update-examples-reference-in-docs.sh ${{inputs.version_number}}'
file_to_commit: 'website/docs/index.html.markdown'
commit_message: 'chore: Updates examples link in index.html.markdown for ${{ github.event.inputs.version_number }} release'
file_to_commit: 'docs/index.md'
commit_message: 'chore: Updates examples link in index.md for ${{ github.event.inputs.version_number }} release'
secrets:
apix_bot_pat: ${{ secrets.APIX_BOT_PAT }}
remote: https://svc-apix-bot:${{ secrets.APIX_BOT_PAT }}@github.com/${{ github.repository }}
Expand Down
6 changes: 0 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ terraform.tfstate
bin/
modules-dev/
/pkg/
website/.vagrant
website/.bundle
website/build
website/node_modules
.vagrant/
*.backup
./*.tfstate
Expand All @@ -34,8 +30,6 @@ __debug_*
coverage.out
simulations

website/vendor

# Test exclusions
!command/test-fixtures/**/*.tfstate
!command/test-fixtures/**/.terraform/
Expand Down
10 changes: 2 additions & 8 deletions GNUmakefile
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ lint:
tools: ## Install dev tools
@echo "==> Installing dependencies..."
go install github.com/icholy/gomajor@latest
go install github.com/client9/misspell/cmd/misspell@latest
go install github.com/terraform-linters/[email protected]
go install github.com/rhysd/actionlint/cmd/actionlint@latest
go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest
Expand All @@ -86,13 +85,8 @@ tools: ## Install dev tools
go install github.com/hashicorp/go-changelog/cmd/changelog-entry@latest
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin $(GOLANGCI_VERSION)

.PHONY: website-lint
website-lint:
@echo "==> Checking website against linters..."
@misspell -error -source=text website/

.PHONY: website
website:
.PHONY: docs
docs:
@echo "Use this site to preview markdown rendering: https://registry.terraform.io/tools/doc-preview"

.PHONY: tflint
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ We ship binaries but do not prioritize fixes for the following operating system


## Troubleshooting
See [Troubleshooting](website/docs/troubleshooting.html.markdown).
See [Troubleshooting](./docs/troubleshooting.md).

## Developing the Provider
See our [contributing guides](./contributing/README.md).
Expand Down
10 changes: 3 additions & 7 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@
- If some deprecated attributes need to be removed in the following release, create a Jira ticket and merge the corresponding PR before starting the release workflow.
You can search in the code for the constansts in [deprecation.go](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/internal/common/constant/deprecation.go) to find them.

### Move old guides

**Note**: Only applies if the right most version digit is 0 (considered a major or minor version in [semantic versioning](https://semver.org/)).

- Keep only [Guides](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/website/docs/guides) for 12 months. Previous versions must be added in the header `subcategory: "Older Guides"`.

### Revise jira release

Before triggering a release, view the corresponding [unreleased jira page](https://jira.mongodb.org/projects/CLOUDP?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=unreleased&contains=terraform) to ensure there are no pending tickets. In case there are pending tickets, verify with the team if the expectation is to have them included within the current release. After release workflow is successful the version will be marked as released automatically.
Expand All @@ -27,7 +21,9 @@ While QA acceptance tests are run in the release process automatically, we check

**Note**: Only applies if the right most version digit is 0 (considered a major or minor version in [semantic versioning](https://semver.org/)).

- A doc in /website/docs/guides/X.Y.0-upgrade-guide.html must be defined containing a summary of the most significant features, breaking changes, and additional information that can be helpful. If not defined the release process will be stopped automatically. The expectation is that this file is created during relevant pull requests (breaking changes, significant features), and not before the release process.
- A doc ./docs/guides/X.Y.0-upgrade-guide.md must be defined containing a summary of the most significant features, breaking changes, and additional information that can be helpful. If not defined the release process will be stopped automatically. The expectation is that this file is created during relevant pull requests (breaking changes, significant features), and not before the release process.

- We keep [Guides](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/docs/guides) only for 12 months. Add header `subcategory: "Older Guides"` to previous versions.

### Trigger release workflow

Expand Down
2 changes: 1 addition & 1 deletion contributing/documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 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)
- 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.md](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/resources/cloud_backup_schedule.md?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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data Source: mongodbatlas_control_plane_ip_addresses

`mongodbatlas_control_plane_ip_addresses` provides a data source that returns all control plane IP addresses.
`mongodbatlas_control_plane_ip_addresses` returns all control plane IP addresses.

## Example Usages
```terraform
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ resource "mongodbatlas_push_based_log_export" "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
}
```

<!-- schema generated by tfplugindocs -->
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
```

<!-- schema generated by tfplugindocs -->
Expand All @@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ private_key = "<MONGODB_ATLAS_PRIVATE_KEY>"
atlas_org_id = "<MONGODB_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.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ private_key = "<MONGODB_ATLAS_PRIVATE_KEY>"
atlas_org_id = "<MONGODB_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.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion scripts/check-upgrade-guide-exists.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
30 changes: 13 additions & 17 deletions scripts/generate-doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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}"
2 changes: 1 addition & 1 deletion scripts/update-examples-reference-in-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion scripts/update-tf-compatibility-matrix.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 0 additions & 2 deletions templates/data-source.md.tmpl
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# {{ if .Name }}{{.Type}}: {{.Name}}{{ end }}

{{ if .Description }} {{ .Description | trimspace }} {{ end }}

## Example Usages
{{ if .Name }}
{{ if eq .Name "mongodbatlas_network_peering" }}
Expand Down
3 changes: 1 addition & 2 deletions templates/data-sources/control_plane_ip_addresses.md.tmpl
Original file line number Diff line number Diff line change
@@ -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 )}}
Expand Down
3 changes: 1 addition & 2 deletions templates/data-sources/push_based_log_export.md.tmpl
Original file line number Diff line number Diff line change
@@ -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 )}}
Expand Down
Loading

0 comments on commit 4e3144c

Please sign in to comment.