mongodb / terraform-provider-mongodbatlas

Terraform MongoDB Atlas Provider: Deploy, update, and manage MongoDB Atlas infrastructure as code through HashiCorp Terraform
https://registry.terraform.io/providers/mongodb/mongodbatlas
Mozilla Public License 2.0
232 stars 164 forks source link

[Bug]: Documentation #2238

Closed AdamMAtWork closed 1 month ago

AdamMAtWork commented 2 months ago

Is there an existing issue for this?

Provider Version

1.16.0

Terraform Version

n/a

Terraform Edition

Terraform Enterprise

Current Behavior

In the terraform provider reference documentation for the mongodbatlas_advanced_cluster resource, under Argument Reference, the argument cluster_type is listed twice. The 2nd occurrence seems to be correct (the text seems to describe options for the cluster type).

However, the 1st occurrence (directly under the name argument) seems to describe something else entirely. The item should be corrected, especially since it is marked as a Required argument.

https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/advanced_cluster#name

Terraform configuration to reproduce the issue

none

Steps To Reproduce

See provider docs

Logs

No response

Code of Conduct

github-actions[bot] commented 2 months ago

Thanks for opening this issue! Please make sure you've followed our guidelines when opening the issue. In short, to help us reproduce the issue we need:

The ticket CLOUDP-247969 was created for internal tracking.

github-actions[bot] commented 2 months ago

This issue has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!

marcosuma commented 1 month ago

Hi @AdamMAtWork thanks so much for opening this issue with su and sorry for the late reply. I've created a PR to fix the documentation as you've correctly indicated.

AdamMAtWork commented 1 month ago

Fabolous!

From: Marco Suma @.> Date: Thursday, May 16, 2024 at 01:49 To: mongodb/terraform-provider-mongodbatlas @.> Cc: Adam Mlodzinski (LCL) @.>, Mention @.> Subject: [EXT] Re: [mongodb/terraform-provider-mongodbatlas] [Bug]: Documentation (Issue #2238) CAUTION: External email. Do not click links or open attachments unless you recognize the sender and know the content is safe.

Hi @AdamMAtWorkhttps://urldefense.com/v3/__https:/github.com/AdamMAtWork__;!!Kg8Pj1cK3Jxx2FEc!VzM9U_-6XiIrt2J5ej9_TwZS6TZRWOt3G7KgXSqFPUz5TZbvLpwz1kNhPLGls-LkFF-iAnebJFmmeVwcHp321KGXA6FLDka_$ thanks so much for opening this issue with su and sorry for the late reply. I've created a PR to fix the documentation as you've correctly indicated.

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/mongodb/terraform-provider-mongodbatlas/issues/2238*issuecomment-2114083633__;Iw!!Kg8Pj1cK3Jxx2FEc!VzM9U_-6XiIrt2J5ej9_TwZS6TZRWOt3G7KgXSqFPUz5TZbvLpwz1kNhPLGls-LkFF-iAnebJFmmeVwcHp321KGXA_X6Y9xi$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/AKTDZFCDGLOZ4Y356C3WHXTZCRCG5AVCNFSM6AAAAABHKAGU4WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMJUGA4DGNRTGM__;!!Kg8Pj1cK3Jxx2FEc!VzM9U_-6XiIrt2J5ej9_TwZS6TZRWOt3G7KgXSqFPUz5TZbvLpwz1kNhPLGls-LkFF-iAnebJFmmeVwcHp321KGXA0Yeo15d$. You are receiving this because you were mentioned.Message ID: @.***>

This email message is confidential, may be legally privileged and is intended for the exclusive use of the addressee. If you received this message in error or are not the intended recipient, you should destroy the email message and any attachments or copies, and you are prohibited from retaining, distributing, disclosing or using any information contained. Please inform us of the delivery error by return email. Thank you for your cooperation.

Le présent message électronique est confidentiel et peut être couvert par le secret professionnel. Il est à l’usage exclusif du destinataire. Si vous recevez ce message par erreur ou si vous n’en êtes pas le destinataire prévu, vous devez détruire le message et toute pièce jointe ou copie et vous êtes tenu de ne pas conserver, distribuer, divulguer ni utiliser tout renseignement qu’il contient. Veuillez nous informer de toute erreur d’envoi en répondant à ce message. Merci de votre collaboration.

github-actions[bot] commented 1 month ago

This issue has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!