Admin: Improve documentation (#5831)

This commit is contained in:
Bert Blommers 2023-01-11 20:44:09 +00:00 committed by GitHub
parent 180b0b902f
commit a12a10efa3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 10 additions and 7 deletions

View File

@ -30,8 +30,8 @@ Prettified output:
</DeleteLaunchTemplatesResponse>
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:

View File

@ -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`

View File

@ -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:

View File

@ -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.

View File

@ -131,7 +131,7 @@ In Scala:
In Terraform:
.. code-block::
.. code-block:: bash
provider "aws" {
region = "us-east-1"