Skip to content

Refine kernel tuning documentation#4

Open
nduytg wants to merge 1 commit intomasterfrom
codex/refactor-cheatsheet-repo-to-markdown-i6gz9y
Open

Refine kernel tuning documentation#4
nduytg wants to merge 1 commit intomasterfrom
codex/refactor-cheatsheet-repo-to-markdown-i6gz9y

Conversation

@nduytg
Copy link
Copy Markdown
Owner

@nduytg nduytg commented Oct 18, 2025

Summary

  • rename the kernel tuning markdown files to use an underscore naming pattern
  • expand the kernel tuning overview with additional persistence guidance and references to kernel ceilings
  • deepen the process and file descriptor limit guide with detailed inspections of soft, hard, and kernel limits
  • restructure the kernel tuning guide to emphasize inspection workflows, persistence best practices, IO scheduler selection, and swap management
  • replace the legacy file descriptor note with a dedicated process-and-file limits reference and remove the obsolete plain text file

Testing

  • ⚠️ pre-commit run --all-files (command not found in container)

https://chatgpt.com/codex/tasks/task_e_68ef8e35203083339da9a266f9a2f3f6

@nduytg nduytg changed the title Clarify kernel tuning limit documentation Refine kernel tuning documentation Oct 18, 2025
@nduytg nduytg requested a review from Copilot October 18, 2025 10:51
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request converts legacy plain-text documentation into Markdown format and refines kernel tuning guides with expanded persistence instructions, process limit diagnostics, and additional references to kernel ceilings.

  • Migrated all .txt cheat sheets (LEMP, SSH, NTP, firewall, Docker, backup, Ansible) to .md format with consistent metadata and fenced code blocks
  • Expanded kernel tuning documentation with new inspection workflows, sysctl persistence patterns, I/O scheduler selection, and swap management
  • Introduced dedicated process and file descriptor limit guide with detailed soft/hard/kernel ceiling explanations
  • Added pre-commit hooks, pymarkdown configuration, and GitHub Actions workflow for Markdown linting

Reviewed Changes

Copilot reviewed 64 out of 64 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
Tunning kernel/tuning_kernel.md New comprehensive kernel tuning overview with inspection commands and persistence best practices
Tunning kernel/process_and_file_limits.md New dedicated guide for process limits, file descriptors, and kernel ceilings
Tunning kernel/Tuning Kernel.txt Removed legacy plain-text kernel tuning file
Tunning kernel/Max file descriptor Removed legacy plain-text file descriptor guide
Web Services/LEMP-*.md Converted LEMP stack installation guides to Markdown
SSH/SSH Overview.md Converted SSH hardening guide to Markdown
NTP/NTP_basic.md Converted NTP configuration guide to Markdown
Firewall/IPtables_basic.md Converted iptables configuration guide to Markdown
Docker/*.md Converted multi-part Docker tutorial series to Markdown
Backup/*.md Converted backup script documentation to Markdown
README.md Updated repository overview with Markdown linting instructions
.pre-commit-config.yaml, .pymarkdown.json, .github/workflows/markdown-lint.yml Added linting infrastructure

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

and comment the entry in `/etc/fstab` to make the change permanent.

```bash
sudo swapoff -a
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sed pattern uses complex quoting and group references that may confuse readers. Consider adding an explanatory comment above this line describing that it comments out all swap entries in /etc/fstab by prepending a # to lines matching the pattern.

Suggested change
sudo swapoff -a
sudo swapoff -a
# Comment out all swap entries in /etc/fstab by prepending a '#'

Copilot uses AI. Check for mistakes.

- **Author:** nduytg
- **Version:** 0.3
- **Date:** 2017-04-12
Copy link

Copilot AI Oct 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The date format is inconsistent with the format used in other files in this PR. Other files use YYYY-MM-DD format (e.g., '2017-11-14'), while this file uses YYYY-DD-MM format ('2017-04-12'). For consistency, consider standardizing on YYYY-MM-DD throughout the repository.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants