Skip to content

docs migration - Getting Started with the Static Linux SDK #70

Description

@heckj

Source: documentation/articles/static-linux-getting-started.md
Proposed disposition: Migrate
Proposed destination: platform-guides/Sources/PlatformGuides.docc/static-linux-getting-started.md
Reviewer: @swiftlang/platform-steering-group

Note: The proposal recommends reviewing any changes with previous authors Alastair Houghton and Melissa Herry, and considering whether to rename or split the article into smaller pieces.

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (suggested: Migrate) and confirm destination
  • Create the platform-guides package in this repository (see note above)
  • Update .github/CODEOWNERS to add /platform-guides/* with the Platform Steering Group
  • Reach out to original authors (Alastair Houghton, Melissa Herry) for review coordination
  • Review source for accuracy against current Static Linux SDK release
  • Evaluate whether to keep as a single article or split into focused sub-articles (e.g., installation, building, packaging)
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify SDK installation commands and URLs
    • Verify build and link invocation examples
    • Update any Swift version references
  • Add article (or articles if split) to PlatformGuides.docc/Documentation.md under a "Linux" topic group
  • Run swift package generate-documentation --analyze --warnings-as-errors in platform-guides/
  • Preview locally with swift package --disable-sandbox preview-documentation in platform-guides/
  • Submit PR to this repository for platform steering group review
  • After merge and publication: add redirect_to: in the swift.org source file's front matter
  • Submit redirect PR to swift-org-website

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    content migrationContent originally housed in the swift.org under /documentation/articles

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions