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/provider: Bulk update hcl code block language to terraform #18008

Merged
merged 2 commits into from
Mar 17, 2021

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Mar 10, 2021

Community Note

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

Reference: #15842
Reference: #17810

This is a simple find-replace of triple backtick hcl with triple backtick terraform. This will be automatically covered by tfproviderdocs checking in the future when -enable-contents-check is turned on in GitHub Actions (and other potential Markdown linting).

Previously (example reports):

	* website/docs/r/ami.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/ami_copy.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/ami_from_instance.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/ami_launch_permission.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/api_gateway_account.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/api_gateway_api_key.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/api_gateway_authorizer.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
...

Output from acceptance testing: N/A (documentation)

Reference: #15842
Reference: #17810

This is a simple find-replace of ```hcl with ```terraform. This will be automatically covered by `tfproviderdocs` checking in the future when `-enable-contents-check` is turned on in GitHub Actions (and other potential Markdown linting).

Previously (example reports):

```
	* website/docs/r/ami.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/ami_copy.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/ami_from_instance.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/ami_launch_permission.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/api_gateway_account.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/api_gateway_api_key.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
	* website/docs/r/api_gateway_authorizer.html.markdown: error checking file contents: example section code block language (hcl) should be: ```terraform
...
```
@bflad bflad requested a review from a team as a code owner March 10, 2021 00:38
@ghost ghost added size/XXL Managed by automation to categorize the size of a PR. labels Mar 10, 2021
Copy link
Member

@breathingdust breathingdust left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 🚀 (aside from merge conflicts)

@bflad bflad merged commit cdfb090 into main Mar 17, 2021
@bflad bflad deleted the d-hcl-code-blocks branch March 17, 2021 15:38
github-actions bot pushed a commit that referenced this pull request Mar 17, 2021
@ghost
Copy link

ghost commented Apr 16, 2021

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Apr 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
size/XXL Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants