feat(documentation): Update language in documentation #99
Conversation
This file contains 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
Signed-off-by: justintlewis <[email protected]>
Correct grammatical error in operational metrics notice. Signed-off-by: justintlewis <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #99 +/- ##
=======================================
Coverage ? 93.54%
=======================================
Files ? 16
Lines ? 4599
Branches ? 108
=======================================
Hits ? 4302
Misses ? 297
Partials ? 0 ☔ View full report in Codecov by Sentry. |
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
krokoko
changed the title
Co-authored-by: Scott Schreckengaust <[email protected]> Signed-off-by: justintlewis <[email protected]>
scottschreckengaust
requested changes
Nov 16, 2023
Co-authored-by: Scott Schreckengaust <[email protected]> Signed-off-by: justintlewis <[email protected]>
DEVELOPER_GUIDE.md
Outdated
| @@ -1,10 +1,10 @@ | |||
| # Developer Guide | |||
|
|
|||
| Generative AI Constructs are built in typescript using Projen (http://projen.io/). This is to support all the associated testing, code checking and compilation for Typescript and Python client. At the moment, there is no dedicated development container, thus you need to configure your local development environment following the steps described below. | |||
| Generative AI CDK Constructs are built in TypeScript using Projen (http://projen.io/). This is to support all the associated testing, code checking, and compilation for TypeScript and Python client. At the moment, there is no dedicated development container, thus you need to configure your local development environment following the steps described below. | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
DEVELOPER_GUIDE.md
Outdated
|
|
||
| ## Testing | ||
|
|
||
| Generative AI Constructs use 2 flavors of testing, unit testing and integration testing. Unit testing targets specific aspects of a construct or one of the functions in the core library. It examines the results and confirms the correct resources are there. For instance, it may call the deployLambdaFunction() in the core library and then confirm that AWS_NODEJS_CONNECTION_REUSE_ENABLED environment variable was set correctly. The unit tests check that certain aspects of the results are correct. You can learn more about unit testing CDK constructs [here](https://docs.aws.amazon.com/cdk/latest/guide/testing.html) and [here](https://aws.amazon.com/blogs/developer/testing-infrastructure-with-the-aws-cloud-development-kit-cdk/). | ||
| Generative AI CDK Constructs use two types of testing: unit testing and integration testing. Unit testing targets specific aspects of a construct or one of the functions in the core library. It examines the results and confirms the correct resources are there. For instance, it may call the deployLambdaFunction() in the core library and then confirm that AWS_NODEJS_CONNECTION_REUSE_ENABLED environment variable was set correctly. The unit tests check that certain aspects of the results are correct. You can learn more about unit testing CDK constructs [here](https://docs.aws.amazon.com/cdk/latest/guide/testing.html) and [here](https://aws.amazon.com/blogs/developer/testing-infrastructure-with-the-aws-cloud-development-kit-cdk/). |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Signed-off-by: justintlewis <[email protected]>
Co-authored-by: Scott Schreckengaust <[email protected]> Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Signed-off-by: justintlewis <[email protected]>
Co-authored-by: Scott Schreckengaust <[email protected]> Signed-off-by: justintlewis <[email protected]>
scottschreckengaust
previously approved these changes
Nov 16, 2023
krokoko
requested changes
Nov 16, 2023
krokoko
approved these changes
Nov 16, 2023
scottschreckengaust
approved these changes
Nov 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Minor langauge tweaks to the readme before public release.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.