Fix docs on providers and their properties #274
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation on providers that were supported was not fully covering all properties and provider types. For some providers and properties, the documentation was not clear on when and how to use them exactly.
sbkok
added a commit
to sbkok/aws-deployment-framework
that referenced
this pull request
Feb 12, 2021
**Features 🏗** * Adds Enterprise Support to account creation process awslabs#233, closes awslabs#232: * ADF will raise a ticket to add the account to an existing AWS support subscription when an account is created. As a prerequisite, your organization master account must already have enterprise support activated. * Adds nested deployment map support awslabs#266 and awslabs#328, closes awslabs#265: * This enables usage of sub directories within the deployment_maps folder. **Fixes 🐞** * Fixes specific role usage to be used in Build and Deploy only awslabs#295. * Corrects removing pipelines anchor in docs awslabs#279. * Fixes CI builds due to isort version mismatch awslabs#284. * Fixes error handling of generate_params intrinsic upload function awslabs#277, closes awslabs#276. * Fixes spec_inline attribute of CodeBuild in docs awslabs#289. * Fixes provider spec_inline support of CodeBuild in awslabs#293. * Fixes supported list of intrinsic upload path styles, enables usage of s3-url and s3-key-only awslabs#275, closes awslabs#299. * Fixes create deployment account concurrency failure awslabs#287, closes awslabs#280. * Fixes approval stage usage, by limiting specific role usage to Build and Deploy steps awslabs#295. * Fixes yarnpkg GPG awslabs#313, closes awslabs#325. * Removes dependency on botocore.vendored.requests awslabs#326, closes awslabs#324. **Improvements ✨** * Improves docs on providers and their properties awslabs#274. * Separates pipeline cleanup from input generation script awslabs#288. * Upgrades Python from v3.7 to v3.8 awslabs#313. * Upgrades CodeBuild image from "aws/codebuild/standard:2.0" to "aws/codebuild/standard:5.0" awslabs#313, closes awslabs#267, closes awslabs#300. * Upgrades CDK from v1.32 to v1.88 awslabs#313, closes awslabs#292.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation on the providers and their supported properties was not up to date. It also did not describe the possible use cases and what to keep in mind when using certain properties.
With this PR, the documentation will be renamed from Types-guide to Provider-guide. I walked through all the providers and their properties, updating the documentation to clarify them.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.