docs migration - Getting Started with the Static Linux SDK
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 5
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 18
Description
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-guidespackage in this repository (see note above) - Update
.github/CODEOWNERSto 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.mdunder a "Linux" topic group - Run
swift package generate-documentation --analyze --warnings-as-errorsinplatform-guides/ - Preview locally with
swift package --disable-sandbox preview-documentationinplatform-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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with documentation/articles/static-linux-getting-started.md and compare it with the proposed platform-guides/Sources/PlatformGuides.docc/static-linux-getting-started.md destination. Review the package, CODEOWNERS, and Documentation.md checklist items, then run the two Swift documentation commands in platform-guides/. Done means the article is migrated and validated for DocC, with the required review and redirect work identified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100