Skip to content

docs(general): consistency around admonitions and snippets #919

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.

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

Merged
merged 22 commits into from
Dec 30, 2021
Merged
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
8c06557
docs: Consistency around admonitions
DanyC97 Dec 20, 2021
2ff5edf
docs: adjust wording and unnecessary collapse
heitorlessa Dec 30, 2021
3cdc27a
docs(logger): adjust wording and unnecessary collapse
heitorlessa Dec 30, 2021
eb3534f
docs(metrics): improve word placement on env vars
heitorlessa Dec 30, 2021
ee38dcd
docs(style): make simple code expr bold
heitorlessa Dec 30, 2021
7c56887
revert: one-line admonition for consistency
heitorlessa Dec 30, 2021
0e2b64f
docs(logger): revert example due to low eyesight issue
heitorlessa Dec 30, 2021
1d28fd2
docs: revert SAM example due to low eyesight
heitorlessa Dec 30, 2021
2a7c082
docs: address last TODOs
heitorlessa Dec 30, 2021
f063550
docs(homepage): use title for simple code blocks
heitorlessa Dec 30, 2021
1822ebe
docs(tracer): update single code blocks to title
heitorlessa Dec 30, 2021
08e6da7
docs(logger): update single code blocks to title
heitorlessa Dec 30, 2021
7f6d94d
docs(metrics): update single code blocks to title
heitorlessa Dec 30, 2021
33680e4
docs(event_handler): update single code blocks to title
heitorlessa Dec 30, 2021
136b977
docs(middleware): update single code blocks to title
heitorlessa Dec 30, 2021
00c40e0
docs(parameters): update single code blocks to title; papercuts
heitorlessa Dec 30, 2021
585b286
docs(batch): update single code blocks to title
heitorlessa Dec 30, 2021
7822852
docs(validation): update single code blocks to title
heitorlessa Dec 30, 2021
bf6507c
docs(parser): update single code blocks to title
heitorlessa Dec 30, 2021
a7a7161
docs(idempotency): update single code blocks to title; simplified wor…
heitorlessa Dec 30, 2021
a5685c3
docs(feature_flags): update single code blocks to title; simplified w…
heitorlessa Dec 30, 2021
10ed9fe
docs(jmespath): update single code blocks to title
heitorlessa Dec 30, 2021
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
Prev Previous commit
Next Next commit
docs(homepage): use title for simple code blocks
  • Loading branch information
heitorlessa committed Dec 30, 2021
commit f063550b83ab9507a4255f617974a685418151fd
34 changes: 13 additions & 21 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,24 +396,18 @@ If using SAM, you can include this SAR App as part of your shared Layers stack,
- Ref: "PowertoolsLayerIamRole"
```

You can fetch available versions via SAR API with:
You can fetch available versions via SAR ListApplicationVersions API:

=== "shell"

```bash
aws serverlessrepo list-application-versions \
--application-id arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer
```
```bash title="AWS CLI example"
aws serverlessrepo list-application-versions \
--application-id arn:aws:serverlessrepo:eu-west-1:057560766410:applications/aws-lambda-powertools-python-layer
```

## Quick getting started

**Quick hello world example using SAM CLI**

=== "shell"

```bash
sam init --location https://github.com/aws-samples/cookiecutter-aws-sam-python
```
```bash title="Hello world example using SAM CLI"
sam init --location https://github.com/aws-samples/cookiecutter-aws-sam-python
```

## Features

Expand Down Expand Up @@ -455,12 +449,10 @@ You can fetch available versions via SAR API with:

## Debug mode

As a best practice, AWS Lambda Powertools logging statements are suppressed. If necessary, you can enable debugging using `set_package_logger`:

=== "app.py"
As a best practice, AWS Lambda Powertools module logging statements are suppressed. If necessary, you can enable debugging using `set_package_logger` for additional information on every internal operation:

```python
from aws_lambda_powertools.logging.logger import set_package_logger
```python title="Powertools debug mode example"
from aws_lambda_powertools.logging.logger import set_package_logger

set_package_logger()
```
set_package_logger()
```