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

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/makefile-cheat-sheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

The Terraform AWS Provider Makefile includes a lot of functionality to make working on the provider easier and more efficient. Many contributors are familiar with using the Makefile for running acceptance tests, but there is a lot more functionality hidden in this humble file.

**NOTE:** See [Continuous Integration](continuous-integration.md) for more information about the CI-focused parts of the Makefile.
!!! tip
See [Continuous Integration](continuous-integration.md) for more information about the CI-focused parts of the Makefile.

## Basics

Expand Down Expand Up @@ -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

Targets that [meta and dependent targets](#meta-targets-and-dependent-targets) run may not all respect the same set of variables.

* `ACCTEST_PARALLELISM` - (Default: `20`) Number of concurrent acceptance tests to run. Overridden if `P` is set.
* `ACCTEST_TIMEOUT` - (Default: `360m`) Timeout before acceptance tests panic.
Expand Down Expand Up @@ -83,7 +85,8 @@ Variables are often defined before the `make` call on the same line, such as `MY
* **Legacy?**: Indicates whether the target is a legacy holdover. Use caution with a legacy target! It may not work, or it may perform checks or fixes that do _not_ align with current practices. In the future, this target should be removed, modernized, or verified to still have value.
* **Vars**: [Variables](#variables) that you can set when using the target, such as `MY_VAR=42 make my-target`. [Meta and dependent targets](#meta-targets-and-dependent-targets) run other targets that may not respect the same variables.

**TIP:** Makefile autocompletion works out of the box on Zsh (the default shell for Terminal on macOS) and Fish shells. For Bash, the `bash-completion` package, among others, provides Makefile autocompletion. Using autocompletion allows you, for example, to type `make ac`, press _tab_, and the shell autocompletes `make acctest-lint`.
!!! tip
Makefile autocompletion works out of the box on Zsh (the default shell for Terminal on macOS) and Fish shells. For Bash, the `bash-completion` package, among others, provides Makefile autocompletion. Using autocompletion allows you, for example, to type `make ac`, press _tab_, and the shell autocompletes `make acctest-lint`.

| Target | Description | CI? | Legacy? | Vars |
| --- | --- | --- | --- | --- |
Expand Down