Address PR Review Feedback: Update mkdocs Navigation and Enhance Memory Settings Doc #4169
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
…ing memory and OOM troubleshooting. Added a link to the official cgroups v1 documentation. Added instructions for editing `grub.cfg` on the device. Provided details on where to find OOM (Out Of Memory) messages. Fixed minor punctuation issue in the section about EVE services hitting memory limits. Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
OhmSpectator
force-pushed
the
fix/clarify-mem-settings
branch
from
295be18
to
e4dd6ea
Compare
|
Fixed the Yetus complain 🤦🏼♂️ |
docs/mkdocs/mkdocs.yml
Outdated
| @@ -226,3 +226,4 @@ nav: | |||
| - UEFI: 'pkg/uefi/rpi/README.md' | |||
| - WLAN: 'pkg/wlan/FIXME.md' | |||
| - 'Clock Synchronization': 'docs/CLOCK-SYNCHRONIZATION.md' | |||
| - 'EVE Memory Settings': 'docs/MEMORY-SETTINGS.md' | |||
There was a problem hiding this comment.
Would it make sense to create section Memory (like we have Networking, Security, etc.) and put there link to this doc + memory-monitor/README.md + later psi-*/README.md?
There was a problem hiding this comment.
Done...
Can you remind me how to build the docs?..
There was a problem hiding this comment.
@rene will have to remind us both :)
Included 'EVE Memory Settings' in the mkdocs navigation under a new 'Memory' section. Also add there the memory-monitor doc. Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
OhmSpectator
force-pushed
the
fix/clarify-mem-settings
branch
from
e4dd6ea
to
4ea2ada
Compare
milan-zededa
approved these changes
Aug 27, 2024
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.
Fixes from previous PR review (#4164).
Added missing 'EVE Memory Settings' to mkdocs navigation.
Enhanced MEMORY-SETTINGS.md with additional configuration instructions and OOM troubleshooting tips.
These changes address @milan-zededa's feedback from the previous PR.