Skip to content

Commit 9f79061

Browse files
committed
adding explicit migration plans
1 parent 33f5dae commit 9f79061

File tree

1 file changed

+53
-65
lines changed

1 file changed

+53
-65
lines changed

_info-architecture/0003-swift-docs-proposal.md

Lines changed: 53 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,9 @@ From a mechanical perspective, reviewers are listed in a `CODEOWNERS` file, whic
119119
For example, the structure of the catalogs above might line up to:
120120

121121
```
122-
/APIGuides.docc/* @swiftlang/language-steering-group
123-
/ServerGuides.docc/* @swiftlang/server-workgroup
124-
/InteropGuides.docc/* @swiftlang/cxx-interop-workgroup
125-
/SwiftLangGuides.docc/* @swiftlang/language-steering-group
126-
/ToolGuides.docc/* @swiftlang/platform-steering-group
122+
/api-guidelines/* @swiftlang/language-steering-group
123+
/ecosystem/* @swiftlang/ecosystem-steering-group
124+
/server-guides/* @swiftlang/server-workgroup
127125
```
128126

129127
If a group dissolves, any catalogs can be associated with another group, or revert to control by the Swift Core Team.
@@ -166,6 +164,13 @@ Like the Swift Embedded examples repository, it benefits from close proximity be
166164
### Migrating Jekyll to DocC content in the Swift Docs Repository
167165

168166
Based on the existing content in Swift.org, the general goal is to migrate the majority of what is general documentation content into a DocC format, grouped into the collections below.
167+
168+
All of the listed markdown files would remain in `/documentation`, with their front matter (Jekyll metadata) updated to redirect the URL requests to the new locations as content is migrated and accepted into the new docs repository.
169+
Markdown files prefixed with `_` are typically only included in other files and not referenced by URL, and can be removed after they are migrated.
170+
171+
#### Disposition Plan for files under `documentation`
172+
173+
169174
A few exceptions are detailed after the file names, to accommodate very out-of-date content, or content that's already replicated in other locations.
170175

171176
This proposal is primarily meant to provide a guide to the structure for content as we want to see it,
@@ -176,66 +181,51 @@ A full audit of the documentation for recency and relevancy is worthwhile, but b
176181
The notes of this migration are intended to be guides, and any migration process isn't expected to be done immediately and in one sweep.
177182
The migration can, and should, occur incrementally, building into the docs repository as supported by the community including content reviewers and their availability.
178183

179-
All of the listed markdown files would remain in `/documentation`, with their front matter (Jekyll metadata) updated to redirect the URL requests to the new locations as content is migrated and accepted into the new docs repository.
180-
Markdown files prefixed with `_` are typically only included in other files and not referenced by URL, and can be removed after they are migrated.
181-
182-
- API guidelines
183-
184-
- documentation/api-design-guidelines/index.md
185-
186-
- Server guides
184+
`source` | status & destination
185+
- | - | -
186+
`api-design-guidelines/index.md` | translate to docc, break into multiple articles in `api-guidelines/APIGuidelines.docc`
187+
188+
`server/index.md` | deprecate & redirect to https://www.swift.org/get-started/cloud-services/
189+
`server/guides/index.md` | translate, migrate to top level of `server-guides/ServerGuides.docc`
190+
`server/guides/building.md` |
191+
`server/guides/testing.md` |
192+
`server/guides/memory-leaks-and-usage.md` |
193+
`server/guides/allocations.md` |
194+
`server/guides/linux-perf.md` |
195+
`server/guides/performance.md` |
196+
`server/guides/llvm-sanitizers.md` |
197+
`server/guides/deployment.md` |
198+
`server/guides/packaging.md` |
199+
`server/guides/passkeys.md` |
200+
`server/guides/libraries/log-levels.md` | migrate content into swift-log (https://github.com/apple/swift-log/pull/370)
201+
`server/guides/libraries/concurrency-adoption-guidelines.md`: 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)
202+
`server/guides/deploying/aws-sam-lambda.md` |
203+
`server/guides/deploying/aws-copilot-fargate-vapor-mongo.md` |
204+
`server/guides/deploying/aws.md` |
205+
`server/guides/deploying/digital-ocean.md` |
206+
`server/guides/deploying/ubuntu.md` |
207+
`server/guides/deploying/heroku.md` |
208+
`server/guides/deploying/gcp.md` |
209+
`articles/static-linux-getting-started.md` |
210+
211+
`migration-guide-swift3/_migration-guide.md` | migrate into https://github.com/swiftlang/swift-migration-guide
212+
`migration-guide-swift3/se-0107-migrate.md` | migrate into https://github.com/swiftlang/swift-migration-guide
213+
`migration-guide-swift3/index.md` | migrate into https://github.com/swiftlang/swift-migration-guide
214+
`migration-guide-swift4/_migration-guide.md` | migrate into https://github.com/swiftlang/swift-migration-guide
215+
`migration-guide-swift4/index.md` | migrate into https://github.com/swiftlang/swift-migration-guide
216+
`migration-guide-swift4.2/_migration-guide.md` | migrate into https://github.com/swiftlang/swift-migration-guide
217+
`migration-guide-swift4.2/index.md` | migrate into https://github.com/swiftlang/swift-migration-guide
218+
`migration-guide-swift5/_migration-guide.md` | migrate into https://github.com/swiftlang/swift-migration-guide
219+
`migration-guide-swift5/index.md` | migrate into https://github.com/swiftlang/swift-migration-guide
220+
`concurrency/index.md` | redirect to content at https://www.swift.org/migration/documentation/swift-6-concurrency-migration-guide/enabledataracesafety
221+
222+
`documentation/articles/zero-to-swift-nvim.md` | migrate into `ecosystem/EcosystemTools.docc`
223+
`documentation/articles/zero-to-swift-emacs.md` | migrate into `ecosystem/EcosystemTools.docc`
224+
`documentation/articles/getting-started-with-vscode-swift.md` | migrate into `ecosystem/EcosystemTools.docc`
225+
`articles/wasm-getting-started.md` | translate and migrate into `ecosystem
187226

188-
- documentation/server/index.md
189227

190-
- documentation/server/guides/index.md
191-
- documentation/server/guides/building.md
192-
- documentation/server/guides/testing.md
193-
- documentation/server/guides/memory-leaks-and-usage.md
194-
- documentation/server/guides/allocations.md
195-
- documentation/server/guides/linux-perf.md
196-
- documentation/server/guides/performance.md
197-
198-
- documentation/server/guides/llvm-sanitizers.md
199-
- documentation/server/guides/deployment.md
200-
- documentation/server/guides/packaging.md
201-
- documentation/server/guides/passkeys.md
202-
203-
- documentation/server/guides/libraries/log-levels.md: migrate content into swift-log
204-
- documentation/server/guides/libraries/concurrency-adoption-guidelines.md: remove content & redirect link to existing migration guide
205-
206-
- documentation/server/guides/deploying/aws-sam-lambda.md
207-
- documentation/server/guides/deploying/aws-copilot-fargate-vapor-mongo.md
208-
- documentation/server/guides/deploying/aws.md
209-
- documentation/server/guides/deploying/digital-ocean.md
210-
- documentation/server/guides/deploying/ubuntu.md
211-
- documentation/server/guides/deploying/heroku.md
212-
- documentation/server/guides/deploying/gcp.md
213-
- documentation/articles/static-linux-getting-started.md
214-
215-
- Swift Language Guides
216-
217-
- migrate all of these pieces into https://github.com/swiftlang/swift-migration-guide
218-
- documentation/articles/value-and-reference-types.md
219-
- migration-guide-swift3/_migration-guide.md
220-
- migration-guide-swift3/se-0107-migrate.md
221-
- migration-guide-swift3/index.md
222-
- migration-guide-swift4/_migration-guide.md
223-
- migration-guide-swift4/index.md
224-
- migration-guide-swift4.2/_migration-guide.md
225-
- migration-guide-swift4.2/index.md
226-
- migration-guide-swift5/_migration-guide.md
227-
- migration-guide-swift5/index.md
228-
- documentation/concurrency/index.md (redirect only, its content is effectively already there)
229-
230-
- Tool Guides
231-
232-
- documentation/articles/zero-to-swift-nvim.md
233-
- documentation/articles/zero-to-swift-emacs.md
234-
- documentation/articles/getting-started-with-vscode-swift.md
235-
236-
- WASM
237-
238-
- documentation/articles/wasm-getting-started.md
228+
### Swift.org documentation files & directories remaining:
239229

240230
- C/C++ Interop Guides
241231
- Doug Gregor has indicated a desire to reset and migrate this content into the Swift repository, leveraging code validation that is beyond Swift's Documentation tooling today, and to keep it closely aligned with the relvant code that provides the interop functionality.
@@ -245,8 +235,6 @@ Markdown files prefixed with `_` are typically only included in other files and
245235
- documentation/cxx-interop/status/index.md
246236
- documentation/articles/wrapping-c-cpp-library-in-swift.md
247237

248-
### Swift.org documentation files & directories remaining:
249-
250238
- Remain on swift.org
251239
- documentation/core-libraries/index.md
252240
- documentation/core-libraries/_foundation.md

0 commit comments

Comments
 (0)