diff --git a/docs/docs/configuration/prettify_responses.rst b/docs/docs/configuration/prettify_responses.rst index e592a380a..1c5049877 100644 --- a/docs/docs/configuration/prettify_responses.rst +++ b/docs/docs/configuration/prettify_responses.rst @@ -30,8 +30,8 @@ Prettified output: -Configuration -################# +Enabling Pretty responses +######################### As changing responses can interfere with some external tools, it is disabled by default. If you want to enable it, use environment variable: diff --git a/docs/docs/configuration/recorder/index.rst b/docs/docs/configuration/recorder/index.rst index 11976fd8f..c086fcdb9 100644 --- a/docs/docs/configuration/recorder/index.rst +++ b/docs/docs/configuration/recorder/index.rst @@ -60,8 +60,8 @@ Usage in ServerMode: Note that this feature records and replays the incoming HTTP request. Randomized data created by Moto, such as resource ID's, will not be stored as part of the log. -Configuration -################## +Recorder Configuration +######################## The requests are stored in a file called `moto_recording`, in the directory that Python is run from. You can configure this location using the following environment variable: `MOTO_RECORDER_FILEPATH=/whatever/path/you/want` diff --git a/docs/docs/contributing/installation.rst b/docs/docs/contributing/installation.rst index 739251319..73eccfbc2 100644 --- a/docs/docs/contributing/installation.rst +++ b/docs/docs/contributing/installation.rst @@ -18,8 +18,8 @@ Checking out the code Contributing to Moto involves forking the project. GitHub has a handy guide explaining how to do this: https://docs.github.com/en/get-started/quickstart/contributing-to-projects -Installing Moto -================= +Installing Moto locally +======================== It is recommended to work from some kind of virtual environment, i.e. `virtualenv`, to prevent cross-contamination with other projects. From within such a virtualenv, run the following command to install all required dependencies: diff --git a/docs/docs/getting_started.rst b/docs/docs/getting_started.rst index 4ceb64d8a..ecc01ef2f 100644 --- a/docs/docs/getting_started.rst +++ b/docs/docs/getting_started.rst @@ -217,6 +217,9 @@ You need to ensure that the mocks are actually in place. export AWS_SESSION_TOKEN='testing' export AWS_DEFAULT_REGION='us-east-1' + #. Do no embed credentials directly in your code. This is always considered bad practice, regardless of whether you use Moto. It also makes it impossible to configure fake credentials for testing purposes. + + #. **VERY IMPORTANT**: ensure that you have your mocks set up *BEFORE* your `boto3` client is established. This can typically happen if you import a module that has a `boto3` client instantiated outside of a function. See the pesky imports section below on how to work around this. diff --git a/docs/docs/server_mode.rst b/docs/docs/server_mode.rst index abe1a2613..5960eb2c7 100644 --- a/docs/docs/server_mode.rst +++ b/docs/docs/server_mode.rst @@ -131,7 +131,7 @@ In Scala: In Terraform: -.. code-block:: +.. code-block:: bash provider "aws" { region = "us-east-1"