Improve the installation documentation#6372
Merged
rjbou merged 1 commit intoocaml:masterfrom Feb 12, 2025
Merged
Conversation
fb3848e to
eccd467
Compare
rjbou
reviewed
Feb 12, 2025
Collaborator
rjbou
left a comment
There was a problem hiding this comment.
The commit message should contains the details that is in the first comment
| can check the following table: | ||
|
|
||
| #### Arch Linux | ||
| [](https://repology.org/project/opam/versions) |
Collaborator
There was a problem hiding this comment.
The list is quite long, i'm not sure that it should here but it's better than at the end i think...
Member
Author
There was a problem hiding this comment.
I think it makes much more sense at the beginning rather than the end.
The way users read it is:
- what system do i have?
- is the system package up-to-date?
- If yes use that one (if you don't know how, the list would be right after)
- If not, then the section just before on the binary installer will do
The per-distribution list is only useful for a minority of people (beginners), whereas the repology list is useful much more often in my opinion
eccd467 to
7c3a6a0
Compare
* Replace the individual badge for each distribution&version by repology's vertical-allrepos with its exclude_unsupported=1 option (see https://repology.org/project/referencing/badges) to only show the distribution version not EoL. * Remove Exherbo from the list of supported distribution as it only provides the 11 years out-of-date opam 1.1.1 * Add Alpine Linux to the list * Merge the Debian and Ubuntu steps * Remove mentions of CentOS and RHEL which do not have the opam package * Remove the Distribution.md file which is extremely out-of-date, redundant with the new automatically generated repology badge and requires a huge effort to maintain
7c3a6a0 to
30e8677
Compare
rjbou
approved these changes
Feb 12, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
While reviewing #6367 i realized the installation documentation is outdated and would require constant update not to be.
This PR does:
as well as some general fixes and improvements