Red-DiscordBot
Red-DiscordBot copied to clipboard
Cog-Creators
[docs] docs could use a guide on how to install without JRE for when audio support isn't needed.
Just my opinion here but this is a No from me, A core cog requires it, some third party cogs assume it’s presence, and as part of the public audio API I plan to add to audio JRE becomes a core requirement. Also @MrStonedOne going forward please use the templates and don’t just delete the content reasoning when filling a FR is important.
It's less of a hard no from me. I'm fine with information being added about which dependencies are more optional so long as we can keep it clear for our less experienced users in the process. For a lot of people using our project, this is their first experience with any sort of hosting, so the less likely our docs are to confuse that group unintentionally, the better.
@Drapersniper templates reduce readability: https://github.com/Ultimaker/Cura/issues/6043
So its a hard no from me on that.
Anywho this is disappointing but not surprising. I'll just fork and release my own revision. Thanks anyways.
@MrStonedOne the guy in that issue said it perfectly.
The template is to save us some work asking relevant information every. single. time.
If you are contributing or reporting an issue your should follow the guidelines set by the repo maintainers and not what you feel like doing, they are there for a reason even if you disagree with them.
For example why would this be beneficial for all users and not just yourself? Our ground rules for interacting with the repo state The following when filing issues.
Create any issues for new features you'd like to implement and explain why this feature is useful to everyone and not just you personally.
Feel free to take a moment and read https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/.github/CONTRIBUTING.md
I feel like as the maintainer here that I have to share my thoughts on why we have templates. we have had a lot of issues over the years, with varying levels of quality and details we need to resolve issues. Templates revolve the issue of inconsistent and missing information, we cannot read someone's mind. And we cannot access someone's system. If the issue truely doesn't fit your issue you're describing, by all means do make an blank issue, but at least fill it out more then just a title and a blank text of "See title".
As for the issue at hand, we put the full list of details to setup the bot in it's complete state, if an power user such as your self understands these docs and fully grasps what it does. Then you're ofcourse allowed to go out on your own and modify the setup to what you want it to be.
But for the sake of our support channels and the past experience of people missing requirements such as Java. I find that we'd only need to provide the full install instructions and nothing less. As this tends to confuse some end users.
This has been locked due to behavior involved, but the point remains that if the docs can be modified to support this while leaving it clear to our less experienced users in the process, we're open to the change.