Skip to content

Commit 16b87b3

Browse files
sebstosebsto
committed
add docs to the repo to publish on github pages
1 parent 1f4f0d6 commit 16b87b3

File tree

79 files changed

+82
-81
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+82
-81
lines changed

‎.licenseignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,6 @@ Package.resolved
3333
*.yaml
3434
*.yml
3535
**/.npmignore
36-
**/*.json
36+
**/*.json
37+
docs/*
38+
.unacceptablelanguageignore

‎.unacceptablelanguageignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs

‎Sources/AWSLambdaRuntimeCore/Documentation.docc/quick-setup.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ swift package init --type executable
2323
2. Add dependencies on `AWSLambdaRuntime` library
2424

2525
```swift
26-
// swift-tools-version:5.8
26+
// swift-tools-version:6.0
2727
// The swift-tools-version declares the minimum version of Swift required to build this package.
2828

2929
import PackageDescription
@@ -53,9 +53,7 @@ let package = Package(
5353

5454
3. Write your function code.
5555

56-
> Be sure to rename the `main.swift` file to something else.
57-
58-
Create an instance of `LambdaRuntime` and pass as a closure a function with this signature: `(_ : Event, context: LambdaContext) async throws -> Output` (as defined in the `LambdaHandler` protocol). `Event` must be `Decodable`.
56+
Create an instance of `LambdaRuntime` and pass a function as a closure. The function has this signature: `(_: Event, context: LambdaContext) async throws -> Output` (as defined in the `LambdaHandler` protocol). `Event` must be `Decodable`. `Output` must be `Encodable`.
5957

6058
If your Lambda function is invoked by another AWS service, use the `AWSLambdaEvent` library at [https://github.com/swift-server/swift-aws-lambda-events](https://github.com/swift-server/swift-aws-lambda-events) to represent the input event.
6159

‎docs/assets.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"videos":[],"images":[{"alt":"Swift Icon","type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/03-swift_on_lambda.png"}],"identifier":"03-swift_on_lambda.png"},{"identifier":"04-swift_on_lambda.png","type":"image","alt":"Deploying Swift into AWS Lambda","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/04-swift_on_lambda.png","traits":["1x","light"]}]},{"identifier":"00-swift_on_lambda.png","type":"image","alt":"Swift on AWS Lambda icons","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/00-swift_on_lambda.png"}]},{"identifier":"01-swift_on_lambda.png","type":"image","alt":"A Swift project open in Xcode","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/01-swift_on_lambda.png"}]},{"alt":"AWS console login","identifier":"04-02-01-console-login.png","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}],"type":"image"},{"identifier":"04-02-10-test-lambda-result.png","type":"image","alt":"Create function","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}]},{"variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"alt":"Create function","type":"image","identifier":"04-02-05-create-function.png"},{"alt":"AWS console login with IAM user","identifier":"04-02-02-console-login.png","type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]}]},{"type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/04-01-compile-for-linux.png","traits":["1x","light"]}],"identifier":"04-01-compile-for-linux.png","alt":"Compile for Amazon Linux"},{"type":"image","identifier":"04-02-09-test-lambda.png","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}],"alt":"Create function"},{"variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"type":"image","identifier":"04-02-06-create-function.png","alt":"Create function details"},{"type":"image","identifier":"04-02-04-select-lambda.png","alt":"AWS console - Select Lambda","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}]},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]}],"identifier":"04-02-03-select-region.png","alt":"AWS console - Select Region","type":"image"},{"identifier":"04-02-08-upload-zip.png","type":"image","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"alt":"Create function"},{"identifier":"04-02-create-lambda.png","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/04-02-create-lambda.png","traits":["1x","light"]}],"alt":"Create a Lambda function","type":"image"},{"alt":"Upload ","identifier":"04-02-07-upload-zip.png","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}],"type":"image"},{"type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/04-03-invoke-lambda.png"}],"identifier":"04-03-invoke-lambda.png","alt":"Invoke a Lambda function"},{"type":"image","alt":"Docker icon and menu on macOS","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}],"identifier":"04-01-01-docker-started.png"},{"alt":"project open in Xcode","type":"image","identifier":"03-01-xcode.png","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}]},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/03-02-swift-package-manager.png","traits":["1x","light"]}],"type":"image","identifier":"03-02-swift-package-manager.png","alt":"Swift Package Manager icon as a box"},{"alt":"Compile and run the project","type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"identifier":"03-04-01-compile-run.png"},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/03-04-test-locally.png","traits":["1x","light"]}],"alt":"Icons of succeeded and failed tests","type":"image","identifier":"03-04-test-locally.png"},{"identifier":"03-03-swift-code-xcode.png","alt":"Swift code in Xcode","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/03-03-swift-code-xcode.png","traits":["1x","light"]}],"type":"image"},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-40-select-zip-file.png","traits":["1x","light"]}],"alt":"Console - select zip file","identifier":"console-40-select-zip-file","type":"image"},{"identifier":"console-80-delete-role","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/console-80-delete-role.png"}],"alt":"Console - delete IAM role","type":"image"},{"type":"image","alt":"Console - Lambda dashboard when there is no function","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/console-20-dashboard.png"}],"identifier":"console-20-dashboard"},{"type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/console-80-delete-function.png"}],"alt":"Console - delete function","identifier":"console-80-delete-function"},{"alt":"Console - select zip file","identifier":"console-50-upload-zip","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-50-upload-zip.png","traits":["1x","light"]}],"type":"image"},{"identifier":"console-10-regions","alt":"Console - Select AWS Region","type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-10-regions.png","traits":["1x","light"]}]},{"alt":"Console - create function","identifier":"console-30-create-function","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-30-create-function.png","traits":["1x","light"]}],"type":"image"},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-60-prepare-test-event.png","traits":["1x","light"]}],"type":"image","identifier":"console-60-prepare-test-event","alt":"Console - prepare test event"}],"downloads":[]}
1+
{"images":[{"identifier":"03-swift_on_lambda.png","alt":"Swift Icon","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/03-swift_on_lambda.png","traits":["1x","light"]}],"type":"image"},{"type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/00-swift_on_lambda.png"}],"identifier":"00-swift_on_lambda.png","alt":"Swift on AWS Lambda icons"},{"variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/04-swift_on_lambda.png"}],"identifier":"04-swift_on_lambda.png","alt":"Deploying Swift into AWS Lambda","type":"image"},{"variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/01-swift_on_lambda.png"}],"identifier":"01-swift_on_lambda.png","alt":"A Swift project open in Xcode","type":"image"},{"alt":"Console - Select AWS Region","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-10-regions.png","traits":["1x","light"]}],"identifier":"console-10-regions","type":"image"},{"alt":"Console - delete function","type":"image","identifier":"console-80-delete-function","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-80-delete-function.png","traits":["1x","light"]}]},{"type":"image","alt":"Console - delete IAM role","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-80-delete-role.png","traits":["1x","light"]}],"identifier":"console-80-delete-role"},{"alt":"Console - select zip file","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-50-upload-zip.png","traits":["1x","light"]}],"type":"image","identifier":"console-50-upload-zip"},{"alt":"Console - prepare test event","type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-60-prepare-test-event.png","traits":["1x","light"]}],"identifier":"console-60-prepare-test-event"},{"type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-40-select-zip-file.png","traits":["1x","light"]}],"alt":"Console - select zip file","identifier":"console-40-select-zip-file"},{"identifier":"console-30-create-function","type":"image","alt":"Console - create function","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-30-create-function.png","traits":["1x","light"]}]},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/console-20-dashboard.png","traits":["1x","light"]}],"alt":"Console - Lambda dashboard when there is no function","type":"image","identifier":"console-20-dashboard"},{"type":"image","identifier":"03-04-01-compile-run.png","alt":"Compile and run the project","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}]},{"identifier":"03-01-xcode.png","alt":"project open in Xcode","type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}]},{"type":"image","identifier":"03-02-swift-package-manager.png","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/03-02-swift-package-manager.png","traits":["1x","light"]}],"alt":"Swift Package Manager icon as a box"},{"type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/03-04-test-locally.png"}],"identifier":"03-04-test-locally.png","alt":"Icons of succeeded and failed tests"},{"identifier":"03-01-terminal-package-init.png","type":"image","alt":"A Terminal with package init command","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/03-01-terminal-package-init.png","traits":["1x","light"]}]},{"alt":"Swift code in Xcode","type":"image","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/03-03-swift-code-xcode.png"}],"identifier":"03-03-swift-code-xcode.png"},{"identifier":"04-02-03-select-region.png","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]}],"alt":"AWS console - Select Region","type":"image"},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}],"identifier":"04-02-04-select-lambda.png","type":"image","alt":"AWS console - Select Lambda"},{"variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]}],"type":"image","identifier":"04-02-01-console-login.png","alt":"AWS console login"},{"type":"image","identifier":"04-01-compile-for-linux.png","alt":"Compile for Amazon Linux","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/04-01-compile-for-linux.png","traits":["1x","light"]}]},{"type":"image","alt":"Create function details","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"identifier":"04-02-06-create-function.png"},{"alt":"Invoke a Lambda function","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/04-03-invoke-lambda.png","traits":["1x","light"]}],"type":"image","identifier":"04-03-invoke-lambda.png"},{"alt":"Create a Lambda function","type":"image","identifier":"04-02-create-lambda.png","variants":[{"traits":["1x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/04-02-create-lambda.png"}]},{"alt":"AWS console login with IAM user","identifier":"04-02-02-console-login.png","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]}],"type":"image"},{"identifier":"04-02-05-create-function.png","alt":"Create function","type":"image","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}]},{"identifier":"04-02-07-upload-zip.png","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"alt":"Upload ","type":"image"},{"identifier":"04-02-10-test-lambda-result.png","alt":"Create function","type":"image","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}]},{"variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"},{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","dark"]}],"type":"image","alt":"Create function","identifier":"04-02-09-test-lambda.png"},{"identifier":"04-02-08-upload-zip.png","variants":[{"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]","traits":["2x","light"]},{"traits":["2x","dark"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}],"type":"image","alt":"Create function"},{"identifier":"04-01-01-docker-started.png","alt":"Docker icon and menu on macOS","type":"image","variants":[{"traits":["2x","light"],"url":"\/images\/AWSLambdaRuntimeCore\/[email protected]"}]}],"downloads":[],"videos":[]}

‎docs/data/documentation/awslambdaruntimecore.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/data/documentation/awslambdaruntimecore/0001-v2-api.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)