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
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
166
164
### Migrating Jekyll to DocC content in the Swift Docs Repository
167
165
168
166
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
+
169
174
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.
170
175
171
176
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
176
181
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.
177
182
The migration can, and should, occur incrementally, building into the docs repository as supported by the community including content reviewers and their availability.
178
183
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)
- 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
0 commit comments