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

improvements to documentation and install.py for Linux performance tweaks #495

Closed
mmguero opened this issue Jun 19, 2024 · 0 comments
Closed
Assignees
Labels
doc Relating to Malcolm documentation enhancement New feature or request install.py Relating to the install.py configuration script performance Related to speed/performance
Milestone

Comments

@mmguero
Copy link
Collaborator

mmguero commented Jun 19, 2024

Stemming from #494 (thanks @jtlindsey), we should improve the documentation in the following ways:

  • There are some platform-specific tips that we should link to earlier in the documentation in the quick start and/or step-by-step guides
  • The linux platform-specific tips should talk about the kernel parameters for cgroup swap stuff (e.g., like this)

Also, install.py should maybe be changed to suggest adding the cgroup stuff to /etc/default/grub and running update-grub for the user automatically.

@mmguero mmguero added doc Relating to Malcolm documentation enhancement New feature or request install.py Relating to the install.py configuration script performance Related to speed/performance labels Jun 19, 2024
@mmguero mmguero added this to the z.staging milestone Jun 19, 2024
@mmguero mmguero added this to Malcolm Jun 19, 2024
@mmguero mmguero moved this to Todo (develop) in Malcolm Jun 19, 2024
@mmguero mmguero modified the milestones: z.staging, v24.07.0 Jun 19, 2024
@mmguero mmguero modified the milestones: v24.07.0, v24.08.0 Jul 18, 2024
@mmguero mmguero modified the milestones: v24.08.0, v24.09.0 Jul 31, 2024
@mmguero mmguero modified the milestones: v24.09.0, z.staging Aug 20, 2024
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Sep 16, 2024
@mmguero mmguero moved this from Todo (develop) to Testing in Malcolm Sep 16, 2024
@mmguero mmguero self-assigned this Sep 17, 2024
@mmguero mmguero closed this as completed Sep 18, 2024
@github-project-automation github-project-automation bot moved this from Testing to Done in Malcolm Sep 18, 2024
This was referenced Sep 18, 2024
@mmguero mmguero moved this from Done to Released in Malcolm Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Relating to Malcolm documentation enhancement New feature or request install.py Relating to the install.py configuration script performance Related to speed/performance
Projects
Status: Released
Development

No branches or pull requests

1 participant