Ensure configuration examples and documentation use current, supported syntax and accurately reflect the actual behavior of the system. Avoid promoting deprecated features, outdated versions, or configuration options that have no effect.
Ensure configuration examples and documentation use current, supported syntax and accurately reflect the actual behavior of the system. Avoid promoting deprecated features, outdated versions, or configuration options that have no effect.
Key practices:
nodejs18.x
, python3.9
) instead of outdated ones (nodejs6.x
, python2.7
)iam.role.statements
instead of iamRoleStatements
)Example of good practice:
# Good: Uses current syntax and supported versions
provider:
name: aws
runtime: nodejs18.x
iam:
role:
statements:
- Effect: Allow
Action: 's3:GetObject'
Resource: '*'
# Bad: Uses deprecated syntax and outdated versions
provider:
name: aws
runtime: nodejs6.x
iamRoleStatements:
- Effect: Allow
Action: 's3:GetObject'
Resource: '*'
This prevents developers from copying ineffective or outdated configuration patterns that may cause deployment issues or use deprecated features.
Enter the URL of a public GitHub repository