Skip to content

Commit 0259490

Browse files
committed
docs: linting for coming out of beta
1 parent 7a31dac commit 0259490

File tree

4 files changed

+18
-11
lines changed

4 files changed

+18
-11
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ can only act retroactive on changes of AWS services. Otherwise, it would be a fu
1111

1212
If a resource is not yet supported by *aws-nuke*, you have two options to resolve this:
1313

14-
* File [an issue](https://github.com/rebuy-de/aws-nuke/issues/new) and describe which resource is missing. This way someone can take care of it.
14+
* File [an issue](https://github.com/ekristen/aws-nuke/issues/new) and describe which resource is missing. This way someone can take care of it.
1515
* Add the resource yourself and open a Pull Request. Please follow the guidelines below to see how to create
1616
such a resource.
1717

@@ -26,15 +26,15 @@ Please check the following points before creating a bug issue:
2626
there are a lot of dependency errors in the first one. The iterations are separated by lines starting with
2727
`Removal requested:` and only the errors in the last block indicate actual errors.
2828

29-
File [an issue](https://github.com/rebuy-de/aws-nuke/issues/new) and describe as accurately as possible how to generate the resource on AWS that cause the
29+
File [an issue](https://github.com/ekristen/aws-nuke/issues/new) and describe as accurately as possible how to generate the resource on AWS that cause the
3030
errors in *aws-nuke*. Ideally this is provided in a reproducible way like a Terraform template or AWS CLI commands.
3131

3232
### I Have Ideas to Improve *aws-nuke*
3333

3434
You should take these steps if you have an idea how to improve *aws-nuke*:
3535

36-
1. Check the [issues page](https://github.com/rebuy-de/aws-nuke/issues), whether someone already had the same or a similar idea.
37-
2. Also check the [closed issues](https://github.com/rebuy-de/aws-nuke/issues?utf8=%E2%9C%93&q=is%3Aissue), because this might have already been implemented, but not yet released. Also,
36+
1. Check the [issues page](https://github.com/ekristen/aws-nuke/issues), whether someone already had the same or a similar idea.
37+
2. Also check the [closed issues](https://github.com/ekristen/aws-nuke/issues?utf8=%E2%9C%93&q=is%3Aissue), because this might have already been implemented, but not yet released. Also,
3838
the idea might not be viable for obvious reasons.
3939
3. Join the discussion, if there is already a related issue. If this is not the case, open a new issue and describe
4040
your idea. Afterward, we can discuss this idea and form a proposal.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ below for more.
2020

2121
This is not a comprehensive list, but here are some of the highlights:
2222

23-
* New Feature: Signed Darwin Binaries for MacOS
23+
* New Feature: Signed Darwin Binaries for macOS
2424
* New Feature: Published Homebrew Tap (ekristen/tap/aws-nuke@3)
2525
* New Feature: Global Filters
2626
* New Feature: Run Against All Enabled Regions
@@ -70,7 +70,7 @@ proper unit tests for it.
7070

7171
## Attribution, License, and Copyright
7272

73-
The rewrite of this tool to use [libnuke](https://github.com/ekristen/libnuke) would not have been posssible without the
73+
The rewrite of this tool to use [libnuke](https://github.com/ekristen/libnuke) would not have been possible without the
7474
hard work that came before me on the original tool by the team and contributors over at [rebuy-de](https://github.com/rebuy-de)
7575
and their original work on [rebuy-de/aws-nuke](https://github.com/rebuy-de/aws-nuke).
7676

docs/cli-examples.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Basic usage
44

55
```bash
6-
aws-nuke --config config.yml
6+
aws-nuke run --config config.yml
77
```
88

99
## Using a profile
@@ -12,10 +12,13 @@ aws-nuke --config config.yml
1212
This assumes you have configured your AWS credentials file with a profile named `my-profile`.
1313

1414
```bash
15-
aws-nuke --config config.yml --profile my-profile
15+
aws-nuke run --config config.yml --profile my-profile
1616
```
1717

18-
## Using the force flags
18+
## Using the prompt flags
19+
20+
!!! note
21+
This used be called the `--force` flag. It has been renamed to `--no-prompt` to better reflect its purpose.
1922

2023
!!! danger
2124
Running without prompts can be dangerous. Make sure you understand what you are doing before using these flags.
@@ -24,5 +27,5 @@ The following is an example of how you automate the command to run without any p
2427
for running in a CI/CD pipeline.
2528

2629
```bash
27-
aws-nuke --config config.yml --force --force-delay 5
30+
aws-nuke run --config config.yml --no-prompt --prompt-delay 5
2831
```

docs/warning.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ To reduce the blast radius of accidents, there are some safety precautions:
2424

2525
4. The account alias must not contain the string `prod`. This string is hardcoded, and it is recommended to add it
2626
to every actual production account (e.g. `mycompany-production-ecr`).
27+
28+
!!! note "ProTip"
29+
This can be disabled by adding `--no-alias-check` to the command line and
30+
[modifying the config accordingly](features/bypass-alias-check.md).
31+
2732
5. The config file contains a blocklist field. If the Account ID of the account you want to nuke is part of this
2833
blocklist, **aws-nuke** will abort. It is recommended, that you add every production account to this blocklist.
2934
6. To ensure you don't just ignore the blocklisting feature, the blocklist must contain at least one Account ID.
@@ -34,4 +39,3 @@ To reduce the blast radius of accidents, there are some safety precautions:
3439
keep up to date.
3540

3641
Feel free to create an issue, if you have any ideas to improve the safety procedures.
37-

0 commit comments

Comments
 (0)