#235 Lots of redundancy in the BSD docs

Open
opened 2 years ago by mreed · 4 comments

Large parts of the BSD documentation are the same, so I think it would be a good idea to merge them all into one page (bsd.md). The reduced redundancy should ease maintenance cost (less documentation), and users are given a clearer idea of just how similar it is to use Libreboot across the BSDs.

Would anyone be okay if I sent a patch for this? I'd rather not waste my time on something that won't get accepted, hence me asking here.

Large parts of the BSD documentation are the same, so I think it would be a good idea to merge them all into one page (bsd.md). The reduced redundancy should ease maintenance cost (less documentation), and users are given a clearer idea of just how similar it is to use Libreboot across the BSDs. Would anyone be okay if I sent a patch for this? I'd rather not waste my time on something that won't get accepted, hence me asking here.
Andrew Robbins commented 2 years ago
Collaborator

This sounds like a good idea, and would be much appreciated if you consolidated those pages. As of right now the amount of information specific to each BSD isn't enough to warrant a separate page for each. If, in the future we actually need separate pages then that can be dealt with at that point in time.

This sounds like a good idea, and would be much appreciated if you consolidated those pages. As of right now the amount of information specific to each BSD isn't enough to warrant a separate page for each. If, in the future we actually need separate pages then that can be dealt with at that point in time.
Michael Reed commented 2 years ago
Poster

Good to hear, I'll submit a patch shortly.


By the way, do you or other contributors feel strongly about keeping the TODOs, at least in the main documentation? To be clear, I don't think they should be removed, just put in a place where they are of more interest, i.e., this bug tracker or as a comment in said documentation.

An example from freebsd.md:

TODO: test FreeBSD more extensively, and make sure it works (and fix it
if it does not). Instructions are provided here, to boot and install
FreeBSD but we're not sure whether it is currently fully compatible
with libreboot.

Such a note does not seem helpful to most users and comes across as messy/incomplete to me.

Good to hear, I'll submit a patch shortly. --- By the way, do you or other contributors feel strongly about keeping the TODOs, at least in the main documentation? To be clear, I don't think they should be removed, just put in a place where they are of more interest, i.e., this bug tracker or as a comment in said documentation. An example from `freebsd.md`: ```text TODO: test FreeBSD more extensively, and make sure it works (and fix it if it does not). Instructions are provided here, to boot and install FreeBSD but we're not sure whether it is currently fully compatible with libreboot. ``` Such a note does not seem helpful to most users and comes across as messy/incomplete to me.
Andrew Robbins commented 2 years ago
Collaborator

I would be fine with removing that TODO from the documentation if you wouldn't mind posting the gist of that text to issue #222 before doing so. If you see any other TODO notes that should be in the issue tracker feel free to open an issue and/or make a pull request.

I would be fine with removing that TODO from the documentation if you wouldn't mind posting the gist of that text to issue #222 before doing so. If you see any other TODO notes that should be in the issue tracker feel free to open an issue and/or make a pull request.
Michael Reed commented 2 years ago
Poster

Sounds good, just did that.

Sounds good, just did that.
Sign in to join this conversation.
Loading...
Cancel
Save
There is no content yet.