requirements docs improved with missing information fixed #142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
mckaygerhard
commented
Jan 13, 2025
mckaygerhard
commented
- Addressed and closed Prerequisites for System Drive too low #131, requirements talk about installation, not updates (not manageable updates), so the wording is correct because later on there are points about that, but i handled the issue in this commit in better way for.
- Improve the very vague requirements documentation, that is also ambiguous in some way.
- Not all software requirements are handled by the OS, for example we need a valid network for communications, if the network is unreachable clients are unable to reach any shared resources.
- OMV is the most flexible NAS system. Pointed that out and tried to clarify all the needs about hardware and software.
- Separate software requirements and hardware requirements. Previous document was very mixed about it, maybe this commit featured a too long one. I'm open to suggestions and leave this PR open to the editors and maintainers for.
- Pointed out that Debian OS is the main software requirement. So then hardware requirements will rely based on OS hardware support!
- Pointed out that NIC is a missing hardware requirement and why. It's a NAS system and wrote about that terminology as well.
- Software requirements are handled by the OS and depend on it, but some packages were pointed out that are important to it, so there will be no confusion about it
- The page should be titled "requirements" because hardware is a prerequisite, but it depends on the core software - the Debian OS, if such hardware is not supported, OMV would not be able to be installed or would not be able to work properly... so prerequisites as a list are very confusing about it
- Set the minimum requirements to be adequate and manageable:
- A 1.5G root filesystem partition was sufficient using the netinstall iso and turning off recommendations, then sdisable auto-updates and create a cron job to clean up the apt package cache storage daily. This does not allow upgrades, but does allow updates. It means a 4G disk system drive is possible and valild. of course, these are for expert users... so I wrote sections of recommendations for novice users.
- a 100M swap was sufficient. I configured Linux to not use swap at all... but novice users won't have the necessary skills, so... of course, these are for expert users... so I wrote sections of recommendations for novice users.
- setting up a NAS system is easy with OMV, but a minimum of knowledge is required for inexperienced users, so I wrote such needs in each section. Warning I indicated that 1 disk is enough for both: system drive storage plus mixed with Data storage, that is basically true and officially supported, if you, as an expert administrator, simply install OMV on top of a fresh Debian setup customized with a free partition available for OMV data drive storage. This could be done by leaving a free partition already formatted also!
- This PR superset requiremends docs improved with missing information fixed #141 because orf misspelled commit and some spell fixes
* Addressed and closed openmediavault#131, requirements talk about installation, not updates (not manageable updates), so the wording is correct because later on there are points about that, but i handled the issue in this commit in better way for. * Improve the very vague requirements documentation, that is also ambiguous in some way. * Not all software requirements are handled by the OS, for example we need a valid network for communications, if the network is unreachable clients are unable to reach any shared resources. * OMV is the most flexible NAS system. Pointed that out and tried to clarify all the needs about hardware and software. * Separate software requirements and hardware requirements. Previous document was very mixed about it, maybe this commit featured a too long one. I'm open to suggestions and leave this PR open to the editors and maintainers for. * Pointed out that Debian OS is the main software requirement. So then hardware requirements will rely based on OS hardware support! * Pointed out that NIC is a missing hardware requirement and why. It's a NAS system and wrote about that terminology as well. * Software requirements are handled by the OS and depend on it, but some packages were pointed out that are important to it, so there will be no confusion about it * The page should be titled "requirements" because hardware is a prerequisite, but it depends on the core software - the Debian OS, if such hardware is not supported, OMV would not be able to be installed or would not be able to work properly... so prerequisites as a list are very confusing about it * Set the minimum requirements to be adequate and manageable: * A 1.5G root filesystem partition was sufficient using the netinstall iso and turning off recommendations, then sdisable auto-updates and create a cron job to clean up the apt package cache storage daily. This does not allow upgrades, but does allow updates. It means a 4G disk system drive is possible and valild. of course, these are for expert users... so I wrote sections of recommendations for novice users. * a 100M swap was sufficient. I configured Linux to not use swap at all... but novice users won't have the necessary skills, so... of course, these are for expert users... so I wrote sections of recommendations for novice users. * setting up a NAS system is easy with OMV, but a minimum of knowledge is required for inexperienced users, so I wrote such needs in each section. **Warning** I indicated that 1 disk is enough for both: system drive storage plus mixed with Data storage, that is basically true and officially supported, if you, as an expert administrator, simply install OMV on top of a fresh Debian setup customized with a free partition available for OMV data drive storage. This could be done by leaving a free partition already formatted also!
votdev
requested changes
Jan 16, 2025
fix misspelled redundancy Co-authored-by: Volker Theile <[email protected]>
* dot point missing Co-authored-by: Volker Theile <[email protected]>
* missing dot point at end of paragraph Co-authored-by: Volker Theile <[email protected]>
Co-authored-by: Volker Theile <[email protected]>
* mispelled word Co-authored-by: Volker Theile <[email protected]>
* miscpelled xpected Co-authored-by: Volker Theile <[email protected]>
Co-authored-by: Volker Theile <[email protected]>
* Add a warning that 32bit works, but with OMV6 32bit support has been stopped officially. It should work, but it is not tested nor new features take care that they might not work on 32bit systems, this is thanks to arch independient technology of OMV development * Fix severals end of paragraphs without dot point. * Fix severals miscspelled Gib to GiB * Fix severals miscspelled words, like xpected, triks and "cos".. * Provide better context for "Spaghetti" sentences, remade all of them also those structurated as bumpy or vagues
* Fix miscspelled archs, sorry this was very rare * x86-64, x64, x86_64 and x86 are valids for AMD64 cos have sabe base and same maning based on anunce in 1999 * separate names on the ARM cases, Debian already supports the 32bit of ARM but i guess OMV will works as same! * 32bit x86 must works cos is the same case, OMV just relies on Debian OS so all the pieces need will be there! * Improved filesystem details on technical notes about lifetime for SSD and complex features like compression.
* add abbreviations for System disk drive and Data disk drives, usefully and reused for software part items in table * the hardware section its not about size, its about hardware per se, although the issue comes down to what Debian supports, devices should really be cited based on use and not based on minimum support, since Debian tries to cover everything while OMV is oriented to a specific task. The example is the difference between WD Black and WD Green, the second will wear out quickly if there is a lot of use. * Same change for software drives, use abbreviations for the item list, specified the size minimal disk, cos Windoze users always think that one disk is one partition, so minimize this table list to that, details such part in the paragraphs below
|
hi @votdev in the commit c759224 based on some issue reports and taking into account that we have a hardware section and a software section, so clarified by moving sizes to the software section additionally i added a technical note that the SMART support depends on what smartmontools supports, this is independent of the operating system. |
votdev
requested changes
Jan 20, 2025
…ed fixes, swap optional * taking in consideration that SSD and HDD are still made and now there is the HHD (Helium Hard drives) those with helium inside for high demand storage .. in speciall NAS systems. the SDD is not the best for NAS systems, HDD/HHD are the best.. so i included the "HHD" inside the formula.. so this information will not be out of date in many years.. cos spining disks still are the best for long data
* https://github.com/openmediavault/openmediavault-docs/actions/runs/12920764345/job/36033630346?pr=142 * prerequisites.rst:16: (ERROR/3) Malformed table. * prerequisites.rst:107: (ERROR/3) Malformed table.
mckaygerhard
commented
Jan 23, 2025
There was a problem hiding this comment.
Changes from #142 (review) merged.. sorry for extra work in your review..
i Add HHD (Helium Hard Drives) to the formula, also some corrections to you
removed with commit 4ed84dc4d823e4f081b3db238bd701fdfe2d18a7 but take in consideration that SSD and HDD are still made and now there is the HHD those with helium inside for high demand storage .. in speciall NAS systems.
- SDD are not the best for NAS systems, HDD/HHD are the best.. so i included the "HHD" inside the formula.. so this information will not be out of date in many years.. cos spining disk still being manufactured
- removed as requested oldoldstable but your wrong: Debian old old stable are still oficially upstream suppoorted by debian around 2 more years.. in fact after that still supported by 5 more years by ExLTS team and freexian
This might be correct, but OMV only supports oldstable for a short period. After that maintenance will be stopped for old OMV versions. This means if Debian moved package repos to archive the old OMV code does not work anymore because the URLs to the package repos will never be updated. That's why i am correct with my statement. |
votdev
approved these changes
Jan 24, 2025
votdev
added a commit
that referenced
this pull request
Jan 24, 2025
* requirements docs improved with missing information fixed * Addressed and closed #131, requirements talk about installation, not updates (not manageable updates), so the wording is correct because later on there are points about that, but i handled the issue in this commit in better way for. * Improve the very vague requirements documentation, that is also ambiguous in some way. * Not all software requirements are handled by the OS, for example we need a valid network for communications, if the network is unreachable clients are unable to reach any shared resources. * OMV is the most flexible NAS system. Pointed that out and tried to clarify all the needs about hardware and software. * Separate software requirements and hardware requirements. Previous document was very mixed about it, maybe this commit featured a too long one. I'm open to suggestions and leave this PR open to the editors and maintainers for. * Pointed out that Debian OS is the main software requirement. So then hardware requirements will rely based on OS hardware support! * Pointed out that NIC is a missing hardware requirement and why. It's a NAS system and wrote about that terminology as well. * Software requirements are handled by the OS and depend on it, but some packages were pointed out that are important to it, so there will be no confusion about it * The page should be titled "requirements" because hardware is a prerequisite, but it depends on the core software - the Debian OS, if such hardware is not supported, OMV would not be able to be installed or would not be able to work properly... so prerequisites as a list are very confusing about it * Set the minimum requirements to be adequate and manageable: * A 1.5G root filesystem partition was sufficient using the netinstall iso and turning off recommendations, then sdisable auto-updates and create a cron job to clean up the apt package cache storage daily. This does not allow upgrades, but does allow updates. It means a 4G disk system drive is possible and valild. of course, these are for expert users... so I wrote sections of recommendations for novice users. * a 100M swap was sufficient. I configured Linux to not use swap at all... but novice users won't have the necessary skills, so... of course, these are for expert users... so I wrote sections of recommendations for novice users. * setting up a NAS system is easy with OMV, but a minimum of knowledge is required for inexperienced users, so I wrote such needs in each section. **Warning** I indicated that 1 disk is enough for both: system drive storage plus mixed with Data storage, that is basically true and officially supported, if you, as an expert administrator, simply install OMV on top of a fresh Debian setup customized with a free partition available for OMV data drive storage. This could be done by leaving a free partition already formatted also! * Update prerequisites.rst per request! fix misspelled redundancy Co-authored-by: Volker Theile <[email protected]> * Update prerequisites.rst due misc spelling * dot point missing Co-authored-by: Volker Theile <[email protected]> * Update prerequisites.rst per requested * missing dot point at end of paragraph Co-authored-by: Volker Theile <[email protected]> * Update prerequisites.rst fix missing context for data drive Co-authored-by: Volker Theile <[email protected]> * Update prerequisites.rst per request! * mispelled word Co-authored-by: Volker Theile <[email protected]> * Update prerequisites.rst per request! misspelled * miscpelled xpected Co-authored-by: Volker Theile <[email protected]> * Update prerequisites.rst per request! resume context for IDE Co-authored-by: Volker Theile <[email protected]> * per request! fix several miscspelled and beter context for * Add a warning that 32bit works, but with OMV6 32bit support has been stopped officially. It should work, but it is not tested nor new features take care that they might not work on 32bit systems, this is thanks to arch independient technology of OMV development * Fix severals end of paragraphs without dot point. * Fix severals miscspelled Gib to GiB * Fix severals miscspelled words, like xpected, triks and "cos".. * Provide better context for "Spaghetti" sentences, remade all of them also those structurated as bumpy or vagues * update requirements : use x86/x64 for AMD64 and detail ARM also * Fix miscspelled archs, sorry this was very rare * x86-64, x64, x86_64 and x86 are valids for AMD64 cos have sabe base and same maning based on anunce in 1999 * separate names on the ARM cases, Debian already supports the 32bit of ARM but i guess OMV will works as same! * 32bit x86 must works cos is the same case, OMV just relies on Debian OS so all the pieces need will be there! * Improved filesystem details on technical notes about lifetime for SSD and complex features like compression. * Update prerequisites.rst disks list size respect brands hardware * add abbreviations for System disk drive and Data disk drives, usefully and reused for software part items in table * the hardware section its not about size, its about hardware per se, although the issue comes down to what Debian supports, devices should really be cited based on use and not based on minimum support, since Debian tries to cover everything while OMV is oriented to a specific task. The example is the difference between WD Black and WD Green, the second will wear out quickly if there is a lot of use. * Same change for software drives, use abbreviations for the item list, specified the size minimal disk, cos Windoze users always think that one disk is one partition, so minimize this table list to that, details such part in the paragraphs below * requirements: remove brands hardware, remove old oldstable, miscspelled fixes, swap optional * taking in consideration that SSD and HDD are still made and now there is the HHD (Helium Hard drives) those with helium inside for high demand storage .. in speciall NAS systems. the SDD is not the best for NAS systems, HDD/HHD are the best.. so i included the "HHD" inside the formula.. so this information will not be out of date in many years.. cos spining disks still are the best for long data * requirements: fix table mailformed * https://github.com/openmediavault/openmediavault-docs/actions/runs/12920764345/job/36033630346?pr=142 * prerequisites.rst:16: (ERROR/3) Malformed table. * prerequisites.rst:107: (ERROR/3) Malformed table. --------- Co-authored-by: Volker Theile <[email protected]> (cherry picked from commit 6f8aa59) Signed-off-by: Volker Theile <[email protected]>
|
Thx |
|
@votdev it LGTM as is, i guess other people will contribute more easy now that we have enought documentation about requirements.. .. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.