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: use tip component on makefile cheat sheet #38411

Merged
merged 1 commit into from
Jul 18, 2024
Merged

docs: use tip component on makefile cheat sheet #38411

merged 1 commit into from
Jul 18, 2024

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Jul 18, 2024

Description

image

@jar-b jar-b requested a review from a team as a code owner July 18, 2024 14:24
@github-actions 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.

@terraform-aws-provider terraform-aws-provider bot added documentation Introduces or discusses updates to documentation. size/XS Managed by automation to categorize the size of a PR. labels Jul 18, 2024
johnsonaj
johnsonaj approved these changes Jul 18, 2024
View reviewed changes
Copy link
Contributor

@johnsonaj johnsonaj left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

johnsonaj
johnsonaj reviewed Jul 18, 2024
View reviewed changes
docs/makefile-cheat-sheet.md
@@ -46,7 +47,8 @@ In the [Cheat Sheet](#cheat-sheet), you can see which variables affect which [ta

Variables are often defined before the `make` call on the same line, such as `MY_VAR=42 make my-target`. However, they can also be set on the same line _after_ the `make` call or in your environment, using, for example, `export MY_VAR=42`.

**NOTE:** Targets that [meta and dependent targets](#meta-targets-and-dependent-targets) run may not all respect the same set of variables.
!!! note
Copy link
Contributor

Choose a reason for hiding this comment

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

is this a !!! tip or !!! note? Or do both work?

Copy link
Member Author

Choose a reason for hiding this comment

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

All the same admonition component, but the color and heading differ between notes and tips.

https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types

ewbankkit
ewbankkit approved these changes Jul 18, 2024
View reviewed changes
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

@jar-b jar-b merged commit 5dba387 into main Jul 18, 2024
38 checks passed
@jar-b jar-b deleted the d-cheat-sheet-tips branch July 18, 2024 15:16
@github-actions github-actions bot added this to the v5.59.0 milestone Jul 18, 2024
@github-actions GitHub Actions
Copy link

This functionality has been released in v5.59.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 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 Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@johnsonaj johnsonaj johnsonaj approved these changes

@ewbankkit ewbankkit ewbankkit approved these changes

Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
Milestone
v5.59.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jar-b @ewbankkit @johnsonaj