Skip to content

Server guide packaging#71

Open
heckj wants to merge 12 commits intoswiftlang:mainfrom
heckj:server-guide-packaging
Open

Server guide packaging#71
heckj wants to merge 12 commits intoswiftlang:mainfrom
heckj:server-guide-packaging

Conversation

@heckj
Copy link
Copy Markdown
Member

@heckj heckj commented Mar 10, 2026

Summary

Updates and migrates content from swift.org article into DocC, expanding two two articles - one focused on building containers for your service, and another touching on using the Static Linux SDK for direct binary generation.

Related Issue

Closes: #17

Type of Change

  • Content error fix (corrects inaccurate information)
  • Enhancement (improves existing content)
  • New content (adds new documentation)
  • Technical change (build system, tooling, infrastructure)
  • Typo or formatting fix

Documentation Package(s) Affected

  • API Guidelines
  • Language Guides
  • Server Guides
  • Ecosystem Tools
  • Repository infrastructure

Testing

Build Verification

  • Ran swift package generate-documentation --analyze --warnings-as-errors successfully
  • Previewed documentation locally with swift package --disable-sandbox preview-documentation

Content Review

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@heckj heckj requested a review from a team as a code owner March 10, 2026 17:12
@heckj heckj self-assigned this Mar 10, 2026
@heckj heckj added content migration Content originally housed in the swift.org under /documentation/articles enhancement New feature or request status: in-review Content is under technical review labels Mar 10, 2026
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So overall this tutorial looks great but I'm not sure we want to make this server specific? CLI tools especially work great with the static SDK

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see where you're going, however I'm not sure how we'd broadly like to reconcile initial goals of porting and updating the swift server guides into DocC and getting them published, specific to the server side use cases. I totally agree it's a fantastic possible mechanism to make easily-used executables that can run on linux or macOS (or other platforms, as long as they can run a Linux container).

I've got queued up to move the "getting started with Static Linux SDK" as it's own article - and it sounds like "Swift on Linux" is a worthwhile thing, @FranzBusch has made the same comments to me. So let me ask - does this article sound like it's wrong or doesn't fit here, because it's more aligned elsewhere or with something else, or are you thinking that we just need a broader scope for content that is "Swift on Linux" more generally?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, general guides for building Swift applications and another guide for building docker images makes sense. Neither of those should be tied to the Swift Server use-case since they are generally useful to many different use-cases.

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

Labels

content migration Content originally housed in the swift.org under /documentation/articles enhancement New feature or request status: in-review Content is under technical review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

packaging ([current](https://www.swift.org/documentation/server/guides/packaging.html))

3 participants