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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,8 +78,8 @@ but don't reflect all the possible future content we might create.
78
78
79
79
- API guidelines - moderated/reviewed by the Language Steering Group.
80
80
- Server guides - moderated/reviewed by the SSWG.
81
-
- Ecosystem Tools Guides - moderated/reviewed by ecosystem steering group.
82
-
- Platform Guides - moderated/reviewed by platform steering group.
81
+
- Ecosystem tools guides - moderated/reviewed by ecosystem steering group.
82
+
- Platform guides - moderated/reviewed by platform steering group.
83
83
84
84
An example `tree` view of such a repository:
85
85
@@ -130,7 +130,7 @@ For example, the structure of the catalogs above might line up to:
130
130
```
131
131
/swift/* @swiftlang/language-steering-group
132
132
/ecosystem/* @swiftlang/ecosystem-steering-group
133
-
/server-guides/* @swiftlang/server-workgroup
133
+
/server/* @swiftlang/server-workgroup
134
134
/platform/* @swifting/platform-steering-group
135
135
```
136
136
@@ -178,7 +178,7 @@ Based on the existing content in Swift.org, the general goal is to migrate the m
178
178
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.
179
179
Markdown files prefixed with `_` are typically only included in other files and not referenced by URL, and can be removed after they are migrated.
180
180
181
-
## Migration Plan
181
+
## Initial Migration Plan
182
182
183
183
This proposal is primarily meant to provide a guide to the structure for content as we want to see it.
184
184
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.
@@ -204,7 +204,7 @@ The navigability between DocC collections and integration of those collections i
204
204
205
205
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.
206
206
207
-
### Swift.org documentation remaining and untouched:
207
+
### Remaining Swift.org documentation content
208
208
209
209
A full migration needs to be coordinated with relevant workgroups, and proceed incrementally as the availability of the community and relevant workgroups allow.
210
210
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.
0 commit comments