Skip to content
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

Recommend Swiftly as install method on Linux #925

Merged
merged 9 commits into from
Nov 1, 2023
Merged

Recommend Swiftly as install method on Linux #925

merged 9 commits into from
Nov 1, 2023

Conversation

a40yostudent
Copy link
Contributor

Any place we say to install Swift on Linux (deploy docs, getting started etc) should use Swiftly instead of directing people to download them from the install pages

gwynne
gwynne previously requested changes Oct 29, 2023
@@ -1,6 +1,6 @@
# Install on Linux

To use Vapor, you will need Swift 5.6 or greater. This can be installed using the toolchains available on [Swift.org](https://swift.org/download/)
To use Vapor, you will need Swift 5.6 or greater. This can be installed using the CLI tool [Swiftly](https://swift-server.github.io/swiftly/) provided by the Swift Server Workgroup (reccommended), or the toolchains available on [Swift.org](https://swift.org/download/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We now require 5.7, not 5.6

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, thank you! I thought I knew that but wasn't able to retrieve this information, can you please point me? I have:

  • corrected the Swift version.
  • corrected a typo on this file
  • corrected all version on the table about linux, added windows that supports Swift 5.7, as reported on swift.org and Fedora website.

!!! note
Swift's [Using Downloads](https://swift.org/download/#using-downloads) guide includes information on how to verify downloads using PGP signatures.
Fetching the latest stable Swift release...
Installing Swift 5.8.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current latest release is 5.9.1, not 5.8.1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

corrected this, thanks. It was copy pasted from the Swiftly Github README file

$ swiftly install latest

Fetching the latest stable Swift release...
Installing Swift 5.8.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5.9.1 again

@gwynne gwynne added the updates Adding new or updated documentation. label Oct 29, 2023
@a40yostudent a40yostudent requested a review from a team as a code owner October 30, 2023 15:38
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you split this out into a separate PR? Thanks!

Copy link
Contributor Author

@a40yostudent a40yostudent Nov 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course. I did it by mistake.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be ok now 👍

@0xTim 0xTim linked an issue Oct 31, 2023 that may be closed by this pull request
Copy link
Member

@0xTim 0xTim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One change around platform support then good to go!

|Fedora|>= 35|>= 5.7|
|CentOS|7|>= 5.7|
|Amazon Linux|2|>= 5.7|
|Windows|10|>= 5.7|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't support Windows

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oooooops!


## Supported Distributions and Versions

Vapor supports the same versions of Linux distributions that Swift 5.6 or newer versions supports.
Vapor supports the same versions of Linux distributions that Swift 5.7 or newer versions supports.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here we can tweak this to remove the note and table and just link to https://www.swift.org/platform-support/ instead

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, this information is doomed to be always not up to date, you're right... What about like this?

## Supported Distributions and Versions

Vapor supports the same versions of Linux distributions that Swift 5.7
or newer versions supports. Please refer to the
[official support page](https://www.swift.org/platform-support/)
in order to find updated information about which operating systems
are officially supported.

Linux distributions not officially supported may also run Swift
by compiling the source code, but Vapor cannot prove stability.
Learn more about compiling Swift from
the [Swift repo](https://github.com/apple/swift#getting-started).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep that works great

Copy link
Member

@0xTim 0xTim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@0xTim 0xTim enabled auto-merge (squash) November 1, 2023 17:02
@0xTim 0xTim requested a review from gwynne November 1, 2023 17:04
@0xTim 0xTim merged commit 33812d6 into vapor:main Nov 1, 2023
1 check passed
@penny-for-vapor penny-for-vapor bot mentioned this pull request Nov 1, 2023
9 tasks
0xTim pushed a commit that referenced this pull request Nov 7, 2023
Issue: #932 

Edited `linux.md` included in pr #925 

The translation of `digital-ocean.md` into Japanese has not been done
yet.
@redsun redsun mentioned this pull request Nov 9, 2023
0xTim pushed a commit that referenced this pull request Nov 23, 2023
update cn doc for PR #925 

@Jinxiansen
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
updates Adding new or updated documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs should use Swiftly
3 participants