documentation
documentation copied to clipboard
[Enhancement] Add crystal version requirement to installation guide
technically, it's already in here: https://github.com/iv-org/documentation/blob/master/Installation.md#install-crystal
technically, it's already in here: https://github.com/iv-org/documentation/blob/master/Installation.md#install-crystal
Which is possibly wrong ? I know I'm using 1.2.2 and have seen it stated that currently that is the version to use, as opposed to 1.3.0. imho there needs to be somewhere prominent referencing the version of crystal required and it needs to kept updated. Ideally the distro specific instructions should show how to obtain that exact version.
I imagine this trips up a lot of first time installers and I know I have trouble at times discovering when it is the time for for a crystal upgrade.
@SamantazFox @matthewmcgarvey Should we force a crystal version in the shards.yml like in https://github.com/iv-org/lsquic.cr/blob/master/shard.yml so that the users know that they have to use a specific crystal version?
I think we already do https://github.com/iv-org/invidious/blob/d199b7264ebdad65c0c5b367bb8d36b2eab55be5/shard.yml#L40
The other thing to do would be to include a .crystal-version file in the root of the project. Not sure how it could be used in our scenario though
@unixfox yes, we should modify the shard.yml file to specify the currently supported versions (i.e 1.0.0 to 1.2.2 inclusive).
And as @gripped said, we should specify a way to get the 1.2.2 version in the install documentation.
Version supported listed here: https://docs.invidious.io/installation/#linux