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

docs: remove dead packages and add package availability notes #4681

Merged
merged 4 commits into from Jul 28, 2022

Conversation

bastimeyer
Copy link
Member

@bastimeyer bastimeyer commented Jul 28, 2022

Closes #4670

Since nobody has had anything to comment about my suggested removal of dead packages from the install docs, I'm just going to submit a PR.

Please see the rendered docs fist. I've tried to be as precise and short as possible in the added notes. I don't mind rewriting/improving it though.

The removals are done in separate commits, in case we want to revert this later on, should the package maintainers start maintaining the packages again.

Copy link
Member

@gravyboat gravyboat left a comment

Choose a reason for hiding this comment

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

Sorry for not commenting on the previous issue @bastimeyer, I don't even remember reading it so I must have missed it. I think the removal plan is good. Some small feedback about the wording in the package availability section.

docs/install.rst Outdated
If a package is not available for your operating system / distro or your system's architecture, or if it's out of date
or broken, then please contact the respective package maintainers or package-repository maintainers.

Please open an issue or pull request on GitHub if an available and maintained package is missing from the install docs.
Copy link
Member

Choose a reason for hiding this comment

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

Do we even want to say this? I feel like people will interpret this incorrectly and open issues because packages are missing any way. Can we make the assumption that package maintainers know what to do?

Copy link
Member Author

Choose a reason for hiding this comment

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

Package maintainers usually don't know or don't care about external documentation. What they care about is the availability of software in their package repos.

I've reworded the section a bit and put more emphasis on when to open issues / PRs for unlisted packages.

@gravyboat
Copy link
Member

Looks great to me!

@gravyboat gravyboat merged commit b03b352 into streamlink:master Jul 28, 2022
@bastimeyer bastimeyer deleted the docs/remove-dead-packages branch July 28, 2022 21:25
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.

Remove dead packages from install docs
2 participants