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

[DOCS] fix console command in developer environment setup instructions #37476

Conversation

florianakos
Copy link
Contributor

@florianakos florianakos commented May 13, 2024

Description

While setting up the Terraform AWS provider locally I noticed an issue with the instructions.
I believe the original version contains a mistake, as executing the command leads to an error:

$ ls -la ./$GOPATH/bin/terraform-provider-aws
ls: .//Users/<xyz_user>/go/bin/terraform-provider-aws: No such file or directory

Instead, when the fixed version of the command is run, the expected output is received:

$ ls -la $GOPATH/bin/terraform-provider-aws
-rwxr-xr-x@ 1 <xyz_user>  user  709759170 May 13 21:05 /Users/<xyz_user>/go/bin/terraform-provider-aws

Relations

Closes #37477

References

Webpage with mistake:
https://hashicorp.github.io/terraform-provider-aws/development-environment/

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
I believe the original version contains a mistake, as executing the command leads to an error:

```
$ ls -la ./$GOPATH/bin/terraform-provider-aws
ls: .//Users/<xyz_user>/go/bin/terraform-provider-aws: No such file or directory
```

Instead, when the fixed version of the command is run, the expected output is received:

```
$ ls -la $GOPATH/bin/terraform-provider-aws
-rwxr-xr-x@ 1 <xyz_user>  user  709759170 May 13 21:05 /Users/<xyz_user>/go/bin/terraform-provider-aws
```
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added documentation Introduces or discusses updates to documentation. size/XS Managed by automation to categorize the size of a PR. labels May 13, 2024
@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label May 13, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome @florianakos 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

@florianakos florianakos marked this pull request as ready for review May 14, 2024 12:22
@florianakos
Copy link
Contributor Author

After reading docs about changelog process, it was still unclear if such small fix requires an entry in .changelog directory. My hunch is that it does not so I did not include it.

Copy link
Member

@justinretzolk justinretzolk left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thank you for taking the time to contribute a fix for this! I'll get it merged once the checks finish up 🚀

@justinretzolk justinretzolk merged commit 634f7d1 into hashicorp:main May 16, 2024
72 checks passed
@github-actions github-actions bot added this to the v5.50.0 milestone May 16, 2024
@terraform-aws-provider terraform-aws-provider bot removed the needs-triage Waiting for first response or review from a maintainer. label May 16, 2024
@florianakos florianakos deleted the d-fix-development-environment-markdown branch May 16, 2024 21:09
Copy link

This functionality has been released in v5.50.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: mistake in command verifying output of make build
2 participants