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

Major cleanup of Linux install instructions #716

Merged
merged 13 commits into from
Oct 28, 2023
Merged

Conversation

joshuaboniface
Copy link
Member

@joshuaboniface joshuaboniface commented Oct 21, 2023

This is an attempt to clean up and streamline the various Linux package install instructions.

  1. (For Debuntu) The main Downloads page now provides just the most basic instructions for using the script install; users are directed to the docs page for more advanced instructions. We don't need walls of text or commands in the quickstart.

  2. The Debian/Ubuntu docs are cleaned up and unified: a) The Debian and Ubuntu sections were mostly identical, so combine them and show only the (single) relevant difference. b) Add a clear command for integrity checking the script. c) Expand some aspects of the manual process for better checking, and link to the script rather than provide a list of codenames that must be constantly updated. d) Cleans up some wording.

  3. The Fedora and CentOS docs are cleaned up: a) Use consistent monospace for package names and capitalization elsewhere. b) Clean up the steps a bit. c) Clarify the source and when a repo will come. d) For CentOS mention that the process is "similar" to Fedora (better than the nothing that was there before).

  4. Use consistent links to the download repository throughout; linking back to the downloads page, which presumably someone came from, is unfriendly. Just link to the right place.

This is an attempt to clean up and streamline the various Linux package
install instructions.

1. The main Downloads page now provides just the most basic instructions
for using the script install; users are directed to the docs page for
more advanced instructions. We don't need walls of text or commands in
the quickstart.

2. The Debian/Ubuntu docs are cleaned up and unified:
  a) The Debian and Ubuntu sections were mostly identical, so combine
  them and show only the (single) relevant difference.
  b) Add a clear command for integrity checking the script.
  c) Expand some aspects of the manual process for better checking, and
  link to the script rather than provide a list of codenames that must
  be constantly updated.
  d) Cleans up some wording.

3. The Fedora and CentOS docs are cleaned up:
  a) Use consistent monospace for package names and capitalization
  elsewhere.
  b) Clean up the steps a bit.
  c) Clarify the source and when a repo will come.
  d) For CentOS mention that the process is "similar" to Fedora (better
  than the nothing that was there before).

4. Use consistent links to the download repository throughout; linking
back to the downloads page, which presumably someone *came from*, is
unfriendly. Just link to the right place.
<code>$CODENAME</code> are valid Debian or Ubuntu values!
</p>
<p>If you do not have <code>curl</code> installed, you can use <code>wget -O-</code> instead of <code>curl</code>.</p>
<p>For more advanced users, the full steps can be [found in the docs](https://jellyfin.org/docs/general/installation/linux#debuntu).</p>
Copy link
Member Author

Choose a reason for hiding this comment

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

I'm iffy on this link. I presume it would be correct but I'm not exactly sure how well Docusaurus handles this.

Copy link
Contributor

@Shadowghost Shadowghost Oct 21, 2023

Choose a reason for hiding this comment

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

You can use relative links too afaik

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh it's more the # part, given that the actual section has a longer title :D

@joshuaboniface joshuaboniface merged commit 5bd7f8a into master Oct 28, 2023
7 checks passed
@joshuaboniface joshuaboniface deleted the install-cleanup branch October 28, 2023 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants