-
Notifications
You must be signed in to change notification settings - Fork 192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[install] Add Swiftly to the install page under beta/preview #830
base: main
Are you sure you want to change the base?
Conversation
🎉 🎉 🎉 Excited to see this :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🥳
@@ -0,0 +1,48 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: Should we use the getting started guide that's in the swiftly documentation set here?
There is already a getting started guide for swiftly written in DocC. You can see its current state published here on SPI:
https://swiftpackageindex.com/swiftlang/swiftly/main/documentation/swiftlydocs/getting-started
It's not aligned with these swift.org website changes yet, but we can get PR's merged to fully align them.
Option 1: Link the detailed swiftly documentation to the SPI site. Use the release branch so that the documentation aligns with what the user will download from swift.org.
Option 2: Take the published DocC HTML from the GitHub action on the swiftly repo and publish it to the swift.org website here. When we run the release workflow it publishes the Linux x86_64 tar.gz, and also the DocC content.
Option 3: Use a CI job to do the same as option 2, just running the docc plugin as the GH workflow does today.
… preview release (#857)
@shahmishal What's the state of the PR? Swiftly already merged their PR two weeks ago so Swiftly is technically unavailable when following the install guide. |
Bring swiftly to swift.org install page under beta/preview.
Linux
macOS