Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add templates for mongodbatlas_search_deployment #1816

Merged
merged 9 commits into from
Jan 9, 2024

Conversation

andreaangiolillo
Copy link
Collaborator

@andreaangiolillo andreaangiolillo commented Jan 8, 2024

Description

Ticket: CLOUDP-221361
This PR adds the templates needed to generate the documentation for the mongodbatlas_search_deployment resource and data source via TFplugindocs. See Spec: Add HashiCorp automation tooling to Terraform development process for more info.

Link to any related issue(s):

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contribution guidelines
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.

Further comments

@andreaangiolillo andreaangiolillo marked this pull request as ready for review January 8, 2024 12:23
@andreaangiolillo andreaangiolillo requested a review from a team as a code owner January 8, 2024 12:23
@andreaangiolillo andreaangiolillo marked this pull request as draft January 8, 2024 12:23
@andreaangiolillo andreaangiolillo marked this pull request as ready for review January 8, 2024 13:01
@@ -0,0 +1,26 @@
---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we follow the convention of placing templates within ./templates folder? reference: https://github.com/hashicorp/terraform-plugin-docs?tab=readme-ov-file#conventional-paths.
For this example it would mean placing the file in ./templates/resources/search_deployment.html.markdown.tmpl

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong opinion here. Updating

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

Copy link
Member

@AgustinBettati AgustinBettati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, would just remove the CLOUDP-* reference from the PR title out of convention

@andreaangiolillo andreaangiolillo changed the title chore: CLOUDP-221361: Add templates for mongodbatlas_search_deployment chore: Add templates for mongodbatlas_search_deployment Jan 9, 2024
@andreaangiolillo andreaangiolillo merged commit babf0aa into master Jan 9, 2024
@andreaangiolillo andreaangiolillo deleted the CLOUDP-221361 branch January 9, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants