SSWG Meeting
- Guest: @Joseph_Heck
- Konrad
- Sebastian
- Joannnis
- Josh
- Simon
- Sven
- Tibor
- Tim
Agenda
- Discuss with Joe goals about new documentation and guides
Please chime in on Macros in foundational libraries
Guides Updates
Joe topic: Migration plan moving them into docc format
-
Joe is on the website workgroup and working on updating all "guides" including the server guides.
- Will work on discoverability and bring it up more into the front
-
building this into a new page and repository "swift docs repo"; process is in front of core team
-
For each of the docs listed Joe put up some ideas what the doc should provide or where it should move or how to update it
-
Most of the server guides were aligned around development cycle
- 6 articles right now but a bit more.
- Building - Build System | Swift.org
- We're missing static linux SDKs info here
- It seems a bit outdated since it was from days when just using swiftpm wasn't so obvious...?
- Tim: How to build for dev and for production is still a topic worth discussing.
- Testing
- This is pretty old, still talks about xctest and doesn't talk about containers etc.
- We should update this about ASAN and TSAN here,
- Give it a big update about swift-testing
- Skip XCTest entirely or mention? We can still mention it.
- Packaging
- Looking for much input here
- Static compilation, tar/zip, docker examples
- Current examples could be improved a lot
- Joannis, Tibor: Cover more complex docker setups as well
- Abandon distroless docs would be ok, focus on Docker
- Breaking out Packaging + Containers to its own page
- New article about building containers, images
- How to build using the GitHub - apple/swift-container-plugin: Build and publish container images using Swift Package Manager plugin
- Tracing article?
- Simon: How to enable distributed tracing within containers
- Setting up and running is hard
- Konrad: You can reuse the swift-otel examples with tracing so you don't have to maintain separately new examples
- Deploying
- Lots of articles
- Tibor: Have some drafts of new ones; some will be deprecated, and overall making progress on those.
Tibor will follow up on this and give Joe the WIP of the new articles- Fargate, EKS, EC2, building with docker compose etc... lots of depth to multiple examples here.
- Building lambda functions is also a bit different
- Performance
- we should mention the new profiling and benchmarking tools
- That's all new content
- we should mention the new profiling and benchmarking tools
-
Potential new content
- Debugging
- How to use lldb
- How to symbolicate crashlogs
- Tracing
- Using telemetry etc?
- Flamegraphs
- Talk about how to measure memory etc.
- Functional and integration testing?
- Local stack for AWS might be a thing to mention here (OSS project)
- Debugging
-
Question about priority of the guides?
- Joannis, Seb: Order is pretty good, let's stick with the existing list order, it already is good
-
All: Comment on Joe’s plans about guides; Joe will do draft PRs and let's then keep reviewing them actively.