From 025949096e0458584973f58f58c3db0ce6e69514 Mon Sep 17 00:00:00 2001 From: Erik Kristensen Date: Thu, 6 Jun 2024 17:32:53 -0600 Subject: [PATCH] docs: linting for coming out of beta --- CONTRIBUTING.md | 8 ++++---- README.md | 4 ++-- docs/cli-examples.md | 11 +++++++---- docs/warning.md | 6 +++++- 4 files changed, 18 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b776724..be84f5d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ can only act retroactive on changes of AWS services. Otherwise, it would be a fu If a resource is not yet supported by *aws-nuke*, you have two options to resolve this: -* 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. +* 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. * Add the resource yourself and open a Pull Request. Please follow the guidelines below to see how to create such a resource. @@ -26,15 +26,15 @@ Please check the following points before creating a bug issue: there are a lot of dependency errors in the first one. The iterations are separated by lines starting with `Removal requested:` and only the errors in the last block indicate actual errors. -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 +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 errors in *aws-nuke*. Ideally this is provided in a reproducible way like a Terraform template or AWS CLI commands. ### I Have Ideas to Improve *aws-nuke* You should take these steps if you have an idea how to improve *aws-nuke*: -1. Check the [issues page](https://github.com/rebuy-de/aws-nuke/issues), whether someone already had the same or a similar idea. -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, +1. Check the [issues page](https://github.com/ekristen/aws-nuke/issues), whether someone already had the same or a similar idea. +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, the idea might not be viable for obvious reasons. 3. Join the discussion, if there is already a related issue. If this is not the case, open a new issue and describe your idea. Afterward, we can discuss this idea and form a proposal. diff --git a/README.md b/README.md index e7b91452..8a4fa480 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ below for more. This is not a comprehensive list, but here are some of the highlights: -* New Feature: Signed Darwin Binaries for MacOS +* New Feature: Signed Darwin Binaries for macOS * New Feature: Published Homebrew Tap (ekristen/tap/aws-nuke@3) * New Feature: Global Filters * New Feature: Run Against All Enabled Regions @@ -70,7 +70,7 @@ proper unit tests for it. ## Attribution, License, and Copyright -The rewrite of this tool to use [libnuke](https://github.com/ekristen/libnuke) would not have been posssible without the +The rewrite of this tool to use [libnuke](https://github.com/ekristen/libnuke) would not have been possible without the hard work that came before me on the original tool by the team and contributors over at [rebuy-de](https://github.com/rebuy-de) and their original work on [rebuy-de/aws-nuke](https://github.com/rebuy-de/aws-nuke). diff --git a/docs/cli-examples.md b/docs/cli-examples.md index 88584c57..5be14338 100644 --- a/docs/cli-examples.md +++ b/docs/cli-examples.md @@ -3,7 +3,7 @@ ## Basic usage ```bash -aws-nuke --config config.yml +aws-nuke run --config config.yml ``` ## Using a profile @@ -12,10 +12,13 @@ aws-nuke --config config.yml This assumes you have configured your AWS credentials file with a profile named `my-profile`. ```bash -aws-nuke --config config.yml --profile my-profile +aws-nuke run --config config.yml --profile my-profile ``` -## Using the force flags +## Using the prompt flags + +!!! note + This used be called the `--force` flag. It has been renamed to `--no-prompt` to better reflect its purpose. !!! danger 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 for running in a CI/CD pipeline. ```bash -aws-nuke --config config.yml --force --force-delay 5 +aws-nuke run --config config.yml --no-prompt --prompt-delay 5 ``` \ No newline at end of file diff --git a/docs/warning.md b/docs/warning.md index 679d8457..a3ca6ce4 100644 --- a/docs/warning.md +++ b/docs/warning.md @@ -24,6 +24,11 @@ To reduce the blast radius of accidents, there are some safety precautions: 4. The account alias must not contain the string `prod`. This string is hardcoded, and it is recommended to add it to every actual production account (e.g. `mycompany-production-ecr`). + + !!! note "ProTip" + This can be disabled by adding `--no-alias-check` to the command line and + [modifying the config accordingly](features/bypass-alias-check.md). + 5. The config file contains a blocklist field. If the Account ID of the account you want to nuke is part of this blocklist, **aws-nuke** will abort. It is recommended, that you add every production account to this blocklist. 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: keep up to date. Feel free to create an issue, if you have any ideas to improve the safety procedures. -