docs migration - Deploying to AWS Lambda using SAM

Open
#60 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
aws, swift
Domain
cloud, documentation

Research direction

Start with documentation/server/guides/deploying/aws-sam-lambda.md and compare it with the proposed server-guides/Sources/ServerGuides.docc/deploying/aws-sam-lambda.md destination. Translate the article, add it to server-guides/Sources/ServerGuides.docc/Documentation.md under Deployment, then run the two listed Swift documentation commands. Done includes successful analysis and preview, workgroup review, and the post-publication redirect updates.

Written by the indexing model from the issue text.

Description

content migration

Source: documentation/server/guides/deploying/aws-sam-lambda.md
Proposed disposition: Migrate
Proposed destination: server-guides/Sources/ServerGuides.docc/deploying/aws-sam-lambda.md
Reviewer: @swiftlang/server-workgroup

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (suggested: Migrate) and confirm destination
  • Review source for accuracy against current AWS SAM CLI, API Gateway, and DynamoDB
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify all SAM CLI commands and CloudFormation template syntax
  • Add article to ServerGuides.docc/Documentation.md under a "Deployment" topic group
  • Run swift package generate-documentation --analyze --warnings-as-errors in server-guides/
  • Preview locally with swift package --disable-sandbox preview-documentation in server-guides/
  • Submit PR to this repository for server workgroup review
  • After merge and publication: add redirect_to: in the swift.org source file's front matter
  • Submit redirect PR to swift-org-website
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from swiftlang/docs

All issues in swiftlang/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.