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

docs: install improvements #2293

Merged
merged 6 commits into from Feb 9, 2019

Conversation

Projects
None yet
2 participants
@bastimeyer
Copy link
Member

bastimeyer commented Feb 2, 2019

These are multiple changes which probably don't belong into one pull request, but since some of them depend on each other, I've added them to just one branch.
Because of this, please don't read the changes as a whole and check each commit individually. If this gets merged, please don't squash.


The main intention of these changes was to rewrite the "Source code" section and suggest to rather use the --user parameter on Linux. The reason for this is that installing python packages system-wide via pip or setuptools can cause issues on certain Linux distros, because packages installed into /usr can conflict with packages of the distro's regular package management. Therefore we should not recommend installing streamlink system-wide. I've also removed this from the script that generates the github releases page.

In order to keep the overall install page more simple, compact, precise and most importantly, consistent, I've also removed the shell prompts from each code block and added sudo to each line where root permissions are required (previously annotated with the # shell prompt instead of $). I am not sure though if sudo is available everywhere and if it always makes sense. However, with this change, it's now possible to use comments in the code blocks, as they now can use proper highlighting.

As a last step, I have split the "other platforms" section into Windows and macOS and moved these two sections to the top. The reason for this is that people generally don't (want to) read and since these OSes are (unfortunately) more common, it's simply better to have them at the top of the document. The detailed Windows instructions are still at the bottom, which means that the old layout doesn't get changed that much. The section anchors however were renamed, which might break links from other documents or somewhere else, not sure.


As a reminder of how to build and see the docs locally:

make --directory=docs clean html
chromium ./docs/_build/html/install.html &
@codecov

This comment has been minimized.

Copy link

codecov bot commented Feb 2, 2019

Codecov Report

Merging #2293 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2293   +/-   ##
=======================================
  Coverage   52.61%   52.61%           
=======================================
  Files         237      237           
  Lines       14758    14758           
=======================================
  Hits         7765     7765           
  Misses       6993     6993
@back-to

back-to approved these changes Feb 5, 2019

@back-to back-to merged commit 7a48061 into streamlink:master Feb 9, 2019

3 checks passed

codecov/project 52.61% (target 30%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment