You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _info-architecture/0003-swift-docs-proposal.md
+42-37Lines changed: 42 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,65 +172,40 @@ Markdown files prefixed with `_` are typically only included in other files and
172
172
## Migration Plan
173
173
174
174
This proposal is primarily meant to provide a guide to the structure for content as we want to see it.
175
-
In the process of establishing this new repository and structure of DocC catalogs, the following files from swift.org are intended to be migrated.
176
-
A full audit of the documentation for recency and relevancy is worthwhile, but beyond the scope of this proposal.
175
+
In the process of establishing this new repository and structure of DocC catalogs, the following initial files from swift.org will be updated (if needed) and migrated, to establish the initial structure.
177
176
178
-
This list is intended to be a guide, with additional potential updates from the relevant reviewing team, and is not expected to be complete in a single sweep.
179
-
The migration can, and should, occur incrementally, building into the docs repository as supported by the community including content reviewers and their availability.
180
-
The migration process itself will be tracked by pull requests and within an issue or issues housed at https://github.com/swiftlang/swift-org-website/, with the issues and tracking to be started if the proposal is approved.
181
-
182
-
Files under the `documentation` directory on Swift.org:
177
+
Files to migrate under the `documentation` directory on Swift.org:
183
178
184
179
|`source`| status & destination |
185
180
| - | - |
186
181
|[`api-design-guidelines/index.md`](https://www.swift.org/documentation/api-design-guidelines/)| translate to docc, break into multiple articles in `api-guidelines/APIGuidelines.docc`|
187
182
|[`server/index.md`](https://www.swift.org/documentation/server/index.html)| deprecate & redirect to https://www.swift.org/get-started/cloud-services/|
188
183
|[`server/guides/index.md`](https://www.swift.org/documentation/server/guides/index.html)| translate, migrate to top level of `server-guides/ServerGuides.docc`|
189
184
|[`server/guides/building.md`](https://www.swift.org/documentation/server/guides/building.html)| refine/update to provide examples of building, add section for debug vs. release and swift tooling, link to SwiftPM docs on building, add section about building in Linux using containers, add section on building with devContainers, add detail on static linux SDK, break out some content to a CI related article |
190
-
|[`server/guides/testing.md`](https://www.swift.org/documentation/server/guides/testing.html)| heavily outdated - update to swift 6, swift-testing, break out some content into a "CI" focused article - focus on unit testing, leave room for functional, integration testing as sep articles |
191
-
|[`server/guides/memory-leaks-and-usage.md`](https://www.swift.org/documentation/server/guides/memory-leaks-and-usage.html)| migrate as is - verify guides still work. Consider breaking into multiple smaller articles. |
192
-
|[`server/guides/allocations.md`](https://www.swift.org/documentation/server/guides/allocations.html)| migrate as is, add reference to package-benchmark to help measure allocations, verify content is still current with subject matter experts |
193
-
|[`server/guides/linux-perf.md`](https://www.swift.org/documentation/server/guides/linux-perf.html)| migrate as is, update examples to use container and latest versions, break out a separate flame-graph article, verify content is still current with subject matter experts |
194
-
|[`server/guides/performance.md`](https://www.swift.org/documentation/server/guides/performance.html)| revise to guidepints for understand performance, reference swift-performance-profiler, package-benchmark, break out flamegraph (what they are, how to read) into it's own article - include perf profiler flamegraphs tool references |
195
-
|[`server/guides/llvm-sanitizers.md`](https://www.swift.org/documentation/server/guides/llvm-sanitizers.html)| merge content into 'build' and 'test' articles, deprecate/remove |
196
-
|[`server/guides/packaging.md`](https://www.swift.org/documentation/server/guides/packaging.html)| add new overview of options, incl static-binary, container. reference runtime dependencies with static compilation options, example of docker w/ 2-stage build and using published docker binaries, break out distroless into it's own article |
197
-
|[`server/guides/passkeys.md`](https://www.swift.org/documentation/server/guides/passkeys.html)| migrate content into article within https://github.com/swift-server/webauthn-swift.git|
198
-
|[`server/guides/libraries/log-levels.md`](https://www.swift.org/documentation/server/guides/libraries/log-levels.html)| migrate content into swift-log (https://github.com/apple/swift-log/pull/370)|
199
-
|[`server/guides/libraries/concurrency-adoption-guidelines.md`](https://www.swift.org/documentation/server/guides/libraries/concurrency-adoption-guidelines.html)| deprecate and redirect to https://www.swift.org/migration/documentation/swift-6-concurrency-migration-guide/enabledataracesafety (https://github.com/swiftlang/swift-org-website/pull/1186)|
200
-
|[`server/guides/deployment.md`](https://www.swift.org/documentation/server/guides/deployment.html)| migrate as is - guide to deploying, revise as guidepost article |
201
-
|[`server/guides/deploying/aws-sam-lambda.md`](https://www.swift.org/documentation/server/guides/deploying/aws-sam-lambda.html)| migrate as is - slightly outdated |
202
-
|[`server/guides/deploying/aws-copilot-fargate-vapor-mongo.md`](https://www.swift.org/documentation/server/guides/deploying/aws-copilot-fargate-vapor-mongo.html)| migrate as is - slightly outdated |
203
-
|[`server/guides/deploying/aws.md`](https://www.swift.org/documentation/server/guides/deploying/aws.html)| migrate as is - slightly outdated |
204
-
|[`server/guides/deploying/digital-ocean.md`](https://www.swift.org/documentation/server/guides/deploying/digital-ocean.html)| migrate as is - slightly outdated |
205
-
|[`server/guides/deploying/ubuntu.md`](https://www.swift.org/documentation/server/guides/deploying/ubuntu.html)| migrate as is - slightly outdated |
206
-
|[`server/guides/deploying/heroku.md`](https://www.swift.org/documentation/server/guides/deploying/heroku.html)| migrate as is - slightly outdated|
207
-
|[`server/guides/deploying/gcp.md`](https://www.swift.org/documentation/server/guides/deploying/gcp.html)| migrate as is - slightly outdated |
185
+
|[`server/guides/testing.md`](https://www.swift.org/documentation/server/guides/testing.html)| quite dated - update to swift 6, swift-testing, break out some content into a "CI" focused article - focus on unit testing, leave room for functional, integration testing as sep articles |
208
186
|[`articles/static-linux-getting-started.md`](https://www.swift.org/documentation/articles/static-linux-getting-started.html)| migrate as is - consider renaming or breaking into multiple, smaller focused articles, review any changes with previous authors (Alastair, Melissa) |
209
-
|`migration-guide-swift3/_migration-guide.md`| migrate into https://github.com/swiftlang/swift-migration-guide|
210
-
|`migration-guide-swift3/se-0107-migrate.md`| migrate into https://github.com/swiftlang/swift-migration-guide|
211
-
|[`migration-guide-swift3/index.md`](https://www.swift.org/migration-guide-swift3/index.html)| migrate into https://github.com/swiftlang/swift-migration-guide|
212
-
|`migration-guide-swift4/_migration-guide.md`| migrate into https://github.com/swiftlang/swift-migration-guide|
213
-
|[`migration-guide-swift4/index.md`](https://www.swift.org/migration-guide-swift4/index.html)| migrate into https://github.com/swiftlang/swift-migration-guide|
214
-
|`migration-guide-swift4.2/_migration-guide.md`| migrate into https://github.com/swiftlang/swift-migration-guide|
215
-
|[`migration-guide-swift4.2/index.md`](https://www.swift.org/migration-guide-swift4.2/index.html)| migrate into https://github.com/swiftlang/swift-migration-guide|
216
-
|`migration-guide-swift5/_migration-guide.md`| migrate into https://github.com/swiftlang/swift-migration-guide|
217
-
|[`migration-guide-swift5/index.md`](https://www.swift.org/migration-guide-swift5/index.html)| migrate into https://github.com/swiftlang/swift-migration-guide|
218
187
|[`concurrency/index.md`](https://www.swift.org/documentation/concurrency/index.html)| redirect to content at https://www.swift.org/migration/documentation/||swift-6-concurrency-migration-guide/enabledataracesafety |
219
188
|[`articles/zero-to-swift-nvim.md`](https://www.swift.org/documentation/articles/zero-to-swift-nvim.html)| migrate into `ecosystem/EcosystemTools.docc`|
220
189
|[`articles/zero-to-swift-emacs.md`](https://www.swift.org/documentation/articles/zero-to-swift-emacs.html)| migrate into `ecosystem/EcosystemTools.docc`|
221
190
|[`articles/getting-started-with-vscode-swift.md`](https://www.swift.org/documentation/articles/getting-started-with-vscode-swift.html)| migrate into `ecosystem/EcosystemTools.docc`|
222
191
|[`articles/wasm-getting-started.md`](https://www.swift.org/documentation/articles/wasm-getting-started.html)| translate and migrate into `ecosystem/WASM.docc`|
223
-
|[`continuous-integration/index.md`](https://www.swift.org/documentation/continuous-integration/index.html)| migrate content to [project-operations](https://github.com/swiftlang/project-operations) repository |
224
-
|[`source-compatibility/index.md`](https://www.swift.org/documentation/source-compatibility/index.html)| migrate to [project-operations](https://github.com/swiftlang/project-operations) repository (referencess to swift source compatibility project) |
225
-
|[`source-code/index.md`](https://www.swift.org/documentation/source-code/index.html)| migrate to [project-operations](https://github.com/swiftlang/project-operations) repository (partial list to existing source code that goes into toolchain, needs updating if kept) |
192
+
193
+
The Swift.org [documentation page](https://www.swift.org/documentation/) will be updated to point to these new DocC catalogs as the content migrates, to provide a way to navigate to the relevant content from swift.org.
194
+
The navigability between DocC collections and integration of those collections into the broader design constraints for swift.org are being dealt with separately, as part of the Swift.org redesign efforts, and beyond the immediate scope of this proposal.
195
+
196
+
As mentioned above, the metadata for the earlier pages will remain on Swift.org for some time, with the stubs of those articles being updated to provide HTML redirects for legacy URLs to the new location once the updated content is published using the DocC catalog.
226
197
227
198
### Swift.org documentation remaining and untouched:
228
199
200
+
A full migration needs to be coordinated with relevant workgroups, and proceed incrementally as the availability of the community and relevant workgroups allow.
201
+
The migration process itself will be tracked by pull requests and within an issue or issues housed at https://github.com/swiftlang/swift-org-website/, and potentially moved to a new docs repository.
202
+
229
203
- documentation/cxx-interop/index.md (Doug Gregor indicated a desire to reset and migrate this content into the Swift repository in the future)
0 commit comments