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.

Sign up for GitHub

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

Jump to bottom

[Docs]: Config and example content for content tabs #33022

Merged
merged 3 commits into from
Sep 19, 2023
Merged

[Docs]: Config and example content for content tabs #33022

merged 3 commits into from
Sep 19, 2023

Conversation

breathingdust
Copy link
Member

Description

To help with the transition to requiring terraform-plugin-framework / aws-sdk-go-v2 all examples in the contributor documentation should lead with the preferred format. We should however preserve legacy examples to help contributors with existing resources. In order to present these various formats in a way that doesn't make the documentation hard to navigate we could use content tabs. This PR includes the mkdocs configuration to allow the use of content tabs, as well as some sample tabs.

References

@github-actions
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 size/M Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. labels Aug 15, 2023
@terraform-aws-provider terraform-aws-provider bot added the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Aug 15, 2023
@jar-b jar-b marked this pull request as ready for review September 19, 2023 14:26
@jar-b jar-b changed the title [Example] Config and example content for content tabs [Docs]: Config and example content for content tabs Sep 19, 2023
@github-actions github-actions bot added size/L Managed by automation to categorize the size of a PR. and removed size/M Managed by automation to categorize the size of a PR. labels Sep 19, 2023
jar-b
jar-b reviewed Sep 19, 2023
View reviewed changes
docs/add-a-new-service.md
return globalaccelerator_sdkv1.New(sess.Copy(config)), nil
}
```
<!-- markdownlint-disable code-block-style -->
Copy link
Member

Choose a reason for hiding this comment

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

I opted to disable this linter check inline rather than globally for now as the code block checking is valuable for the website docs. If this becomes too burdensome for the contributor documentation we can extend the root markdownlint configuration with a second file stored in the docs/ subfolder and disable it globally there instead.

jar-b
jar-b reviewed Sep 19, 2023
View reviewed changes
docs/add-a-new-service.md
}
```
<!-- markdownlint-disable code-block-style -->
=== "aws-go-sdk-v2"
Copy link
Member

Choose a reason for hiding this comment

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

Switched this particular example to just AWS SDK Go V1/V2 as this section of code is the same regardless of whether Terraform Plugin SDK or Framework is used.

@jar-b jar-b merged commit f9e7daa into main Sep 19, 2023
30 checks passed
@jar-b jar-b deleted the d-content-tabs-proto branch September 19, 2023 14:33
@github-actions github-actions bot added this to the v5.18.0 milestone Sep 19, 2023
@github-actions
Copy link

This functionality has been released in v5.18.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!

@github-actions
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 Oct 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jar-b jar-b jar-b approved these changes

Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. size/L Managed by automation to categorize the size of a PR.
Projects
None yet
Milestone
v5.18.0
Development

Successfully merging this pull request may close these issues.
2 participants
@breathingdust @jar-b