docs migration - Deploying to AWS on Amazon Linux 2

Open
#58 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
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
aws, linux, swift
Domain
documentation

Research direction

Start with documentation/server/guides/deploying/aws.md and compare it with the proposed server-guides/Sources/ServerGuides.docc/deploying/aws.md destination. First determine with the server workgroup whether to migrate for Amazon Linux 2023 or deprecate in favor of the Fargate/SAM guides. If migrating, run the listed documentation generation and preview commands; done means the guide is converted, indexed, reviewed, and the required redirects are prepared.

Written by the indexing model from the issue text.

Description

content migration

Source: documentation/server/guides/deploying/aws.md
Proposed disposition: Needs determination (AL2 reached end of life June 2025) — assess whether to update for Amazon Linux 2023 or to deprecate in favor of the Fargate/SAM guides.
Proposed destination: server-guides/Sources/ServerGuides.docc/deploying/aws.md or deprecate
Reviewer: @swiftlang/server-workgroup

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (Migrate updated for AL2023, or Deprecate) and confirm destination or redirect target
  • Review content currency — Amazon Linux 2 is EOL; assess whether to update for AL2023 or deprecate
  • If migrating: translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Update for Amazon Linux 2023 if continuing with this guide
    • Update or remove the blog post link that uses absolute Swift.org URL
  • 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.