Migrate PackageCollections.md to DocC
#8715
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- add more information to the subcommand pages, giving a brief overview before describing the usage of the command itself - update the links to these subcomand pages for the package collection guide
- add a file per topic for package collections - link out to the subcommand reference when applicable
…Formats/v1` into relevant areas
|
@swift-ci please test |
|
@swift-ci please test self hosted macOS platform |
|
@swift-ci please test |
|
@swift-ci please test windows |
|
@swift-ci please test |
|
@swift-ci please test windows |
|
@swift-ci please test |
|
@swift-ci please test windows |
bripeticca
requested review from
jakepetroules,
dschaefer2,
shawnhyam,
plemarquand,
owenv and
bkhouri
as code owners
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The covers the porting of content for
PackageCollections.mdinto our DocC catalog and fixes #8589.The new guide article for
PackageCollectionsexists underSources/PackageManagerDocs/Documentation.docc/PackageCollections.mdand touches on creating, publishing, signing/protecting, and modifying package collections. Below the overview there is a list of subcommands available on theswift package-collectiontool with links navigating to the Swift commands documentation.Each of the
PackageCollectionCLI commands have been augmented with supplementary information about how to use the subcommand (if applicable), all of which is taken from the original/Documentation/PackageCollections.mdmarkdown file.Some links within these guides either still reference the old links in the original
Documentation/PackageCollections.mdfile or are placeholders - both are marked with aTODOto update these links once other issues under #8603 are completed and we can replace the links with the appropriate DocC equivalent.Some content in these guides are also taken from
Sources/PackageCollectionsModel/Formats/v1.