Skip to content

Rename team.html.markdown into teams.html.markdown #838

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

Merged
merged 3 commits into from
Sep 14, 2022
Merged

Rename team.html.markdown into teams.html.markdown #838

merged 3 commits into from
Sep 14, 2022

Conversation

leo-ferlin-sutton
Copy link
Contributor

@leo-ferlin-sutton leo-ferlin-sutton commented Sep 9, 2022

Description

On the documentation website, both in the URL and in the search menu the it shows up as team or mongodbatlas_team singular when the resource name is mongodbatlas_teams.

This is the only resource where the documentation page is spelled differently so I assumed it was a mistake. Same for the data source.

Type of change:

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

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the Terraform contribution guidelines
  • 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

`mongodbatlas_teams` is the only resource in this provider where it's documentation page name/url is spelled differently
@themantissa
Copy link
Collaborator

@leo-ferlin-sutton thank you for the PR. The file names are indeed incorrect however the PR is incomplete. If you rename the files the links to them from the documentation index and any where teams might be linked to in the docs, will now break. If you want to correct this completely we'll need the full docs directory searched for instances of the old name and updated with the new. If you do not want to add to the PR let us know and we'll close and add it to our backlog.

@leo-ferlin-sutton
Copy link
Contributor Author

leo-ferlin-sutton commented Sep 12, 2022

You are correct, I overlooked the index and did not think to update it. I have pushed a new commit with the change.

I have searched and found no other place where team was linked in the documentation (I only looked at the website directory and it's subdirectories).

@themantissa
Copy link
Collaborator

Thank you @leo-ferlin-sutton! Appreciate the extra effort here.

Copy link
Collaborator

@themantissa themantissa left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@Zuhairahmed Zuhairahmed left a comment

Choose a reason for hiding this comment

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

Great catch @leo-ferlin-sutton. LGTM

@themantissa themantissa merged commit 8b7f583 into mongodb:master Sep 14, 2022
@leo-ferlin-sutton leo-ferlin-sutton deleted the patch-1 branch September 15, 2022 09:37
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.

3 participants