Skip to content

Commit eb42a1e

Browse files
committed
docs: project name consistency
Co-authored-by: William McCarthy [email protected]>
1 parent 5dbdd5f commit eb42a1e

File tree

4 files changed

+47
-45
lines changed

4 files changed

+47
-45
lines changed

docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ A suite of utilities for AWS Lambda functions to ease adopting best practices su
1818

1919
2) [**Share your work**](https://github.com/awslabs/aws-lambda-powertools-python/issues/new?assignees=&labels=community-content&template=share_your_work.yml&title=%5BI+Made+This%5D%3A+%3CTITLE%3E). Blog posts, video, sample projects you used Powertools!
2020

21-
3) Use [**Lambda Layers**](#lambda-layer) or [**SAR**](#sar), if possible. This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Lambda Powertools languages.
21+
3) Use [**Lambda Layers**](#lambda-layer) or [**SAR**](#sar), if possible. This helps us understand who uses Powertools in a non-intrusive way, and helps us gain future investments for other Powertools languages.
2222

23-
When using Layers, you can add Lambda Powertools as a dev dependency (or as part of your virtual env) to not impact the development process.
23+
When using Layers, you can add Powertools as a dev dependency (or as part of your virtual env) to not impact the development process.
2424

2525
## Install
2626

@@ -59,7 +59,7 @@ This means you need to add AWS SDK as a development dependency (not as a product
5959

6060
[Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html){target="_blank"} is a .zip file archive that can contain additional code, pre-packaged dependencies, data, or configuration files. Layers promote code sharing and separation of responsibilities so that you can iterate faster on writing business logic.
6161

62-
You can include Lambda Powertools Lambda Layer using [AWS Lambda Console](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html#invocation-layers-using){target="_blank"}, or your preferred deployment framework.
62+
You can include Powertools Lambda Layer using [AWS Lambda Console](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.html#invocation-layers-using){target="_blank"}, or your preferred deployment framework.
6363

6464
??? note "Note: Click to expand and copy any regional Lambda Layer ARN"
6565

@@ -585,7 +585,7 @@ Compared with the [public Layer ARN](#lambda-layer) option, SAR allows you to ch
585585
value = data.aws_serverlessapplicationrepository_application.sar_app.semantic_version
586586
}
587587

588-
# Fetch Lambda Powertools Layer ARN from deployed SAR App
588+
# Fetch Powertools Layer ARN from deployed SAR App
589589
output "aws_lambda_powertools_layer_arn" {
590590
value = aws_serverlessapplicationrepository_cloudformation_stack.deploy_sar_stack.outputs.LayerVersionArn
591591
}
@@ -673,7 +673,7 @@ sam init --location https://github.com/aws-samples/cookiecutter-aws-sam-python
673673

674674
## Features
675675

676-
Core utilities such as Tracing, Logging, Metrics, and Event Handler will be available across all Lambda Powertools languages. Additional utilities are subjective to each language ecosystem and customer demand.
676+
Core utilities such as Tracing, Logging, Metrics, and Event Handler will be available across all Powertools languages. Additional utilities are subjective to each language ecosystem and customer demand.
677677

678678
| Utility | Description |
679679
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -728,7 +728,7 @@ When `POWERTOOLS_DEV` is set to a truthy value (`1`, `true`), it'll have the fol
728728

729729
## Debug mode
730730

731-
As a best practice for libraries, AWS Lambda Powertools module logging statements are suppressed.
731+
As a best practice for libraries, Powertools module logging statements are suppressed.
732732

733733
When necessary, you can use `POWERTOOLS_DEBUG` environment variable to enable debugging. This will provide additional information on every internal operation.
734734

docs/tutorial/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Tutorial
33
description: Powertools introduction
44
---
55

6+
<!-- markdownlint-disable MD043 MD041 -->
7+
68
This tutorial progressively introduces Lambda Powertools core utilities by using one feature at a time.
79

810
## Requirements
@@ -343,7 +345,7 @@ Let's include Lambda Powertools as a dependency in `requirement.txt`, and use Ev
343345
=== "requirements.txt"
344346

345347
```bash
346-
aws-lambda-powertools
348+
aws-lambda-powertools[tracer] # Tracer requires AWS X-Ray SDK dependency
347349
```
348350

349351
Use `sam build && sam local start-api` and try run it locally again.

docs/utilities/feature_flags.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following sample infrastructure will be used throughout this documentation:
5353

5454
```yaml hl_lines="5 11 18 25 31-50 54"
5555
AWSTemplateFormatVersion: "2010-09-09"
56-
Description: Lambda Powertools Feature flags sample template
56+
Description: Lambda Powertools for Python Feature flags sample template
5757
Resources:
5858
FeatureStoreApp:
5959
Type: AWS::AppConfig::Application
@@ -580,20 +580,20 @@ The `conditions` block is a list of conditions that contain `action`, `key`, and
580580

581581
The `action` configuration can have the following values, where the expressions **`a`** is the `key` and **`b`** is the `value` above:
582582

583-
Action | Equivalent expression
584-
------------------------------------------------- | ---------------------------------------------------------------------------------
585-
**EQUALS** | `lambda a, b: a == b`
586-
**NOT_EQUALS** | `lambda a, b: a != b`
587-
**KEY_GREATER_THAN_VALUE** | `lambda a, b: a > b`
588-
**KEY_GREATER_THAN_OR_EQUAL_VALUE** | `lambda a, b: a >= b`
589-
**KEY_LESS_THAN_VALUE** | `lambda a, b: a < b`
590-
**KEY_LESS_THAN_OR_EQUAL_VALUE** | `lambda a, b: a <= b`
591-
**STARTSWITH** | `lambda a, b: a.startswith(b)`
592-
**ENDSWITH** | `lambda a, b: a.endswith(b)`
593-
**KEY_IN_VALUE** | `lambda a, b: a in b`
594-
**KEY_NOT_IN_VALUE** | `lambda a, b: a not in b`
595-
**VALUE_IN_KEY** | `lambda a, b: b in a`
596-
**VALUE_NOT_IN_KEY** | `lambda a, b: b not in a`
583+
| Action | Equivalent expression |
584+
| ----------------------------------- | ------------------------------ |
585+
| **EQUALS** | `lambda a, b: a == b` |
586+
| **NOT_EQUALS** | `lambda a, b: a != b` |
587+
| **KEY_GREATER_THAN_VALUE** | `lambda a, b: a > b` |
588+
| **KEY_GREATER_THAN_OR_EQUAL_VALUE** | `lambda a, b: a >= b` |
589+
| **KEY_LESS_THAN_VALUE** | `lambda a, b: a < b` |
590+
| **KEY_LESS_THAN_OR_EQUAL_VALUE** | `lambda a, b: a <= b` |
591+
| **STARTSWITH** | `lambda a, b: a.startswith(b)` |
592+
| **ENDSWITH** | `lambda a, b: a.endswith(b)` |
593+
| **KEY_IN_VALUE** | `lambda a, b: a in b` |
594+
| **KEY_NOT_IN_VALUE** | `lambda a, b: a not in b` |
595+
| **VALUE_IN_KEY** | `lambda a, b: b in a` |
596+
| **VALUE_NOT_IN_KEY** | `lambda a, b: b not in a` |
597597

598598
???+ info
599599
The `**key**` and `**value**` will be compared to the input from the `**context**` parameter.
@@ -667,16 +667,16 @@ AppConfig store provider fetches any JSON document from AWS AppConfig.
667667

668668
These are the available options for further customization.
669669

670-
Parameter | Default | Description
671-
------------------------------------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------
672-
**environment** | `""` | AWS AppConfig Environment, e.g. `test`
673-
**application** | `""` | AWS AppConfig Application
674-
**name** | `""` | AWS AppConfig Configuration name
675-
**envelope** | `None` | JMESPath expression to use to extract feature flags configuration from AWS AppConfig configuration
676-
**max_age** | `5` | Number of seconds to cache feature flags configuration fetched from AWS AppConfig
677-
**sdk_config** | `None` | [Botocore Config object](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html){target="_blank"}
678-
**jmespath_options** | `None` | For advanced use cases when you want to bring your own [JMESPath functions](https://github.com/jmespath/jmespath.py#custom-functions){target="_blank"}
679-
**logger** | `logging.Logger` | Logger to use for debug. You can optionally supply an instance of Powertools Logger.
670+
| Parameter | Default | Description |
671+
| -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
672+
| **environment** | `""` | AWS AppConfig Environment, e.g. `test` |
673+
| **application** | `""` | AWS AppConfig Application |
674+
| **name** | `""` | AWS AppConfig Configuration name |
675+
| **envelope** | `None` | JMESPath expression to use to extract feature flags configuration from AWS AppConfig configuration |
676+
| **max_age** | `5` | Number of seconds to cache feature flags configuration fetched from AWS AppConfig |
677+
| **sdk_config** | `None` | [Botocore Config object](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html){target="_blank"} |
678+
| **jmespath_options** | `None` | For advanced use cases when you want to bring your own [JMESPath functions](https://github.com/jmespath/jmespath.py#custom-functions){target="_blank"} |
679+
| **logger** | `logging.Logger` | Logger to use for debug. You can optionally supply an instance of Powertools Logger. |
680680

681681
```python hl_lines="21-27" title="AppConfigStore sample"
682682
from botocore.config import Config
@@ -771,17 +771,17 @@ def test_flags_condition_match(mocker):
771771

772772
## Feature flags vs Parameters vs env vars
773773

774-
Method | When to use | Requires new deployment on changes | Supported services
775-
------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------
776-
**[Environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html){target="_blank"}** | Simple configuration that will rarely if ever change, because changing it requires a Lambda function deployment. | Yes | Lambda
777-
**[Parameters utility](parameters.md)** | Access to secrets, or fetch parameters in different formats from AWS System Manager Parameter Store or Amazon DynamoDB. | No | Parameter Store, DynamoDB, Secrets Manager, AppConfig
778-
**Feature flags utility** | Rule engine to define when one or multiple features should be enabled depending on the input. | No | AppConfig
774+
| Method | When to use | Requires new deployment on changes | Supported services |
775+
| --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------------------------------------- |
776+
| **[Environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html){target="_blank"}** | Simple configuration that will rarely if ever change, because changing it requires a Lambda function deployment. | Yes | Lambda |
777+
| **[Parameters utility](parameters.md)** | Access to secrets, or fetch parameters in different formats from AWS System Manager Parameter Store or Amazon DynamoDB. | No | Parameter Store, DynamoDB, Secrets Manager, AppConfig |
778+
| **Feature flags utility** | Rule engine to define when one or multiple features should be enabled depending on the input. | No | AppConfig |
779779

780780
## Deprecation list when GA
781781

782-
Breaking change | Recommendation
783-
------------------------------------------------- | ---------------------------------------------------------------------------------
784-
`IN` RuleAction | Use `KEY_IN_VALUE` instead
785-
`NOT_IN` RuleAction | Use `KEY_NOT_IN_VALUE` instead
786-
`get_enabled_features` | Return type changes from `List[str]` to `Dict[str, Any]`. New return will contain a list of features enabled and their values. List of enabled features will be in `enabled_features` key to keep ease of assertion we have in Beta.
787-
`boolean_type` Schema | This **might** not be necessary anymore before we go GA. We will return either the `default` value when there are no rules as well as `when_match` value. This will simplify on-boarding if we can keep the same set of validations already offered.
782+
| Breaking change | Recommendation |
783+
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
784+
| `IN` RuleAction | Use `KEY_IN_VALUE` instead |
785+
| `NOT_IN` RuleAction | Use `KEY_NOT_IN_VALUE` instead |
786+
| `get_enabled_features` | Return type changes from `List[str]` to `Dict[str, Any]`. New return will contain a list of features enabled and their values. List of enabled features will be in `enabled_features` key to keep ease of assertion we have in Beta. |
787+
| `boolean_type` Schema | This **might** not be necessary anymore before we go GA. We will return either the `default` value when there are no rules as well as `when_match` value. This will simplify on-boarding if we can keep the same set of validations already offered. |

docs/we_made_this.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: We Made This (Community)
3-
description: Blog posts, tutorials, and videos about Lambda Powertools created by the Powertools Community.
3+
description: Blog posts, tutorials, and videos about AWS Lambda Powertools created by the Powertools Community.
44
---
55

66
<!-- markdownlint-disable MD001 MD043 -->
77

8-
This space is dedicated to highlight our awesome community content featuring Lambda Powertools 🙏!
8+
This space is dedicated to highlight our awesome community content featuring Powertools 🙏!
99

1010
!!! info "[Get your content featured here](https://github.com/awslabs/aws-lambda-powertools-python/issues/new?assignees=&labels=community-content&template=share_your_work.yml&title=%5BI+Made+This%5D%3A+%3CTITLE%3E){target="_blank"}!"
1111

0 commit comments

Comments
 (0)