Add Quota Documentation #186
Conversation
Updates the container width to fill more of the screen. This is better for the standard widescreen layouts. Add docker to the additionalLanguages for prism. Adds an "About Quotas" page with warnings. Adds documentation on enabling filesystem based quotas for EXT4. Adds Docs on advanced quota management section that covers EXT4. Adds empty pages for other filesystems is support is added.
✅ Deploy Preview for pelica ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughAdds two disk-quota documentation pages, inserts a Disk Quotas category into the sidebar, updates Docusaurus to include Docker syntax highlighting, adds a partition tip to the Wings install guide, and defines explicit CSS container width variables. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Fix all issues with AI agents
In @docs/guides/disk-quotas/about.mdx:
- Line 28: Update the heading "## Filesystem specific docs" to hyphenate the
compound modifier as "## Filesystem-specific docs" so the phrase correctly reads
"filesystem-specific" when modifying "docs" (change the heading text exactly
where "Filesystem specific docs" appears).
In @docs/guides/disk-quotas/ext4-xfs.mdx:
- Line 183: Replace the incorrect fragment "The should be the server UUID as
shown in the examples below" with the corrected sentence "This should be the
server UUID as shown in the examples below." to fix the grammar and complete the
phrase.
- Line 177: Change the phrase "The built in quota management uses blocks by
default." to hyphenate the compound adjective by replacing "built in quota
management" with "built-in quota management" so the line reads "The built-in
quota management uses blocks by default."; update the single occurrence where
the phrase appears (search for "built in quota management" in
docs/guides/disk-quotas/ext4-xfs.mdx).
- Line 10: The sentence "Both EXT4 and XFS use the built in quota management
services in linux." uses an unhyphenated compound adjective; change "built in"
to "built-in" so it reads "Both EXT4 and XFS use the built-in quota management
services in linux.", updating the phrase in the
docs/guides/disk-quotas/ext4-xfs.mdx content where the original sentence
appears.
- Line 38: Update the option description for the `E` flag to fix the spelling:
replace "Extented Options" with "Extended Options" in the bullet that reads "*
The `E` flag is for Extented Options" so it correctly says "* The `E` flag is
for Extended Options".
- Line 25: The sentence "We do not recommended this!" contains a grammar error;
change "recommended" to the base verb "recommend" so the sentence reads "We do
not recommend this!" by editing that exact string in the document.
- Line 140: Typo fix: change the misspelled word "assinged" to "assigned" in the
sentence "Limits for the servers are managed on a "project" level so they can be
assinged per-directory." in docs/guides/disk-quotas/ext4-xfs.mdx (the line
referencing "project" level).
- Line 204: Change the phrase "human readable format" to the hyphenated compound
adjective "human-readable format" in the sentence that describes the
`--human-readable` flag (the line containing "* The `--human-readable` flag sets
the limits to be displayed in a human readable format. By default that is
Megabytes"). Ensure only the adjective is hyphenated so the line reads "* The
`--human-readable` flag sets the limits to be displayed in a human-readable
format. By default that is Megabytes".
🧹 Nitpick comments (1)
docs/guides/disk-quotas/about.mdx (1)
10-10: Consider more concise wording.The phrase "a lot of" could be replaced with "many" for a more concise and professional tone in the documentation.
✍️ Suggested improvement
-## There are a lot of notices here for a reason! +## There are many notices here for a reason!
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
docs/guides/disk-quotas/about.mdxdocs/guides/disk-quotas/btrfs.mdxdocs/guides/disk-quotas/ext4-xfs.mdxdocs/guides/disk-quotas/lvm.mdxdocs/guides/disk-quotas/zfs.mdxdocs/wings/install.mdxdocusaurus.config.tssidebars.tssrc/css/custom.scss
🧰 Additional context used
🪛 LanguageTool
docs/guides/disk-quotas/about.mdx
[style] ~10-~10: Consider using a synonym to be more concise.
Context: ...artition. ## There are a lot of notices here for a reason! <Admonition...
(A_LOT_OF)
[grammar] ~28-~28: Use a hyphen to join words.
Context: ... partition. ## Filesystem specific docs <Link to="/docs/guides/dis...
(QB_NEW_EN_HYPHEN)
docs/guides/disk-quotas/ext4-xfs.mdx
[grammar] ~10-~10: Use a hyphen to join words.
Context: ...T4/XFS. Both EXT4 and XFS use the built in quota management services in linux. ...
(QB_NEW_EN_HYPHEN)
[grammar] ~140-~140: Ensure spelling is correct
Context: ...ged on a "project" level so they can be assinged per-directory. ### Add A New Project...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~177-~177: Use a hyphen to join words.
Context: ...cf9a ``` ### set quota limits The built in quota management uses blocks by defau...
(QB_NEW_EN_HYPHEN)
[grammar] ~204-~204: Use a hyphen to join words.
Context: ...ts the limits to be displayed in a human readable format. By default that is Mega...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (4)
docusaurus.config.ts (1)
112-112: LGTM! Docker syntax highlighting enabled.The addition of "docker" to Prism's additionalLanguages array properly enables syntax highlighting for Docker code blocks in the new quota documentation.
src/css/custom.scss (1)
22-24: LGTM! Container width customization for widescreen layouts.The custom properties correctly override Infima's default container widths to utilize more screen space on larger displays, aligning with the PR objectives.
docs/wings/install.mdx (1)
9-12: LGTM! Helpful operational guidance.This tip appropriately warns users about partition management best practices, which directly relates to the quota documentation being added in this PR. The placement at the beginning of the installation guide ensures visibility.
sidebars.ts (1)
59-67: LGTM! Sidebar navigation properly updated.The new "Disk Quotas" category is correctly structured and appropriately placed under the Guides section. The document references match the new files being added in this PR.
| You can either make a new mount with quotas enabled or enable quotas on an existing partition. | ||
| </Admonition> | ||
|
|
||
| ## Filesystem specific docs |
There was a problem hiding this comment.
Hyphenate compound modifier.
When "filesystem specific" modifies "docs," it should be hyphenated as "filesystem-specific" per standard English grammar rules for compound modifiers.
📝 Proposed fix
-## Filesystem specific docs
+## Filesystem-specific docs📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Filesystem specific docs | |
| ## Filesystem-specific docs |
🧰 Tools
🪛 LanguageTool
[grammar] ~28-~28: Use a hyphen to join words.
Context: ... partition. ## Filesystem specific docs <Link to="/docs/guides/dis...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/about.mdx at line 28, Update the heading "##
Filesystem specific docs" to hyphenate the compound modifier as "##
Filesystem-specific docs" so the phrase correctly reads "filesystem-specific"
when modifying "docs" (change the heading text exactly where "Filesystem
specific docs" appears).
| <Admonition type="warning"> | ||
| Enabling quotas for `/` is difficult, as it requires booting a live disk to change. | ||
|
|
||
| We do not recommended this! |
There was a problem hiding this comment.
Fix grammar: "do not recommend" (not "recommended").
Line 25 has a subject-verb agreement error.
🐛 Proposed fix
- We do not recommended this!
+ We do not recommend this!📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| We do not recommended this! | |
| We do not recommend this! |
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 25, The sentence "We do not
recommended this!" contains a grammar error; change "recommended" to the base
verb "recommend" so the sentence reads "We do not recommend this!" by editing
that exact string in the document.
There was a problem hiding this comment.
Actionable comments posted: 6
🤖 Fix all issues with AI agents
In @docs/guides/disk-quotas/ext4-xfs.mdx:
- Line 38: The bullet text "* The `E` flag is for Extented Options" contains a
spelling mistake; update the string to read "* The `E` flag is for Extended
Options" (locate and edit the list item containing `E` flag in the
docs/guides/disk-quotas/ext4-xfs.mdx content).
- Line 177: The phrase "built in quota management" should be corrected to use a
hyphenated compound adjective: replace "built in quota management" with
"built-in quota management" wherever it appears (for example in the sentence
currently reading "The built in quota management uses blocks by default.") to
ensure proper hyphenation.
- Line 29: Replace the misspelled word "formated" with "formatted" in the
sentence referencing `/dev/sdb` and EXT4 so it reads "`/dev/sdb` as the device
formatted as EXT4 enabling only project quotas."
- Line 10: Update the phrase "built in quota management" to use the compound
adjective form "built-in quota management" so the sentence reads "Both EXT4 and
XFS use the built-in quota management services in linux."; locate the exact
string "built in quota management" in the docs/guides/disk-quotas/ext4-xfs.mdx
content and replace it with "built-in quota management" ensuring only the
hyphenation is changed.
- Line 204: The phrase "human readable format" in the documentation should be
hyphenated as a compound adjective; update the sentence containing
"`--human-readable` flag sets the limits to be displayed in a human readable
format. By default that is Megabytes`" to use "human-readable format" (i.e.,
replace "human readable format" with "human-readable format") so it reads
"`--human-readable` flag sets the limits to be displayed in a human-readable
format. By default that is Megabytes`".
- Line 183: Replace the typo "The should be the server UUID as shown in the
examples below" with "This should be the server UUID as shown in the examples
below"—update the sentence text in docs/guides/disk-quotas/ext4-xfs.mdx where
that exact phrase appears.
🧹 Nitpick comments (1)
docs/guides/disk-quotas/ext4-xfs.mdx (1)
186-187: Improve article usage for clarity.The phrase "set in the Pelican" sounds awkward. Consider "set in Pelican" or "set in the Pelican panel/interface" for better readability.
📝 Suggested improvement
-* The hard limit is set to the disk resource limit set in the Pelican +* The hard limit is set to the disk resource limit set in Pelican
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/disk-quotas/ext4-xfs.mdx
🧰 Additional context used
🪛 LanguageTool
docs/guides/disk-quotas/ext4-xfs.mdx
[grammar] ~10-~10: Use a hyphen to join words.
Context: ...T4/XFS. Both EXT4 and XFS use the built in quota management services in linux. ...
(QB_NEW_EN_HYPHEN)
[grammar] ~177-~177: Use a hyphen to join words.
Context: ...cf9a ``` ### set quota limits The built in quota management uses blocks by defau...
(QB_NEW_EN_HYPHEN)
[grammar] ~204-~204: Use a hyphen to join words.
Context: ...ts the limits to be displayed in a human readable format. By default that is Mega...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (2)
docs/guides/disk-quotas/ext4-xfs.mdx (2)
1-5: LGTM!The imports are appropriate for the MDX documentation with tabs, admonitions, and internal links.
224-226: TODO is tracked and appropriate for this PR.The TODO note is acceptable given the PR description mentions adding "empty/placeholder pages for other filesystems to be filled if support is added." This aligns with the incremental documentation approach.
|
|
||
| This page covers disk quota management for EXT4/XFS. | ||
|
|
||
| Both EXT4 and XFS use the built in quota management services in linux. |
There was a problem hiding this comment.
Fix hyphenation in compound adjective.
The phrase "built in quota management" should use a hyphen: "built-in quota management" since it's a compound adjective modifying a noun.
📝 Proposed fix
-Both EXT4 and XFS use the built in quota management services in linux.
+Both EXT4 and XFS use the built-in quota management services in linux.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Both EXT4 and XFS use the built in quota management services in linux. | |
| Both EXT4 and XFS use the built-in quota management services in linux. |
🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: Use a hyphen to join words.
Context: ...T4/XFS. Both EXT4 and XFS use the built in quota management services in linux. ...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 10, Update the phrase "built in
quota management" to use the compound adjective form "built-in quota management"
so the sentence reads "Both EXT4 and XFS use the built-in quota management
services in linux."; locate the exact string "built in quota management" in the
docs/guides/disk-quotas/ext4-xfs.mdx content and replace it with "built-in quota
management" ensuring only the hyphenation is changed.
| </Admonition> | ||
|
|
||
| These examples use the following: | ||
| `/dev/sdb` as the device formated as EXT4 enabling only project quotas. |
There was a problem hiding this comment.
Fix spelling error.
"formated" should be "formatted".
📝 Proposed fix
-`/dev/sdb` as the device formated as EXT4 enabling only project quotas.
+`/dev/sdb` as the device formatted as EXT4 enabling only project quotas. 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| `/dev/sdb` as the device formated as EXT4 enabling only project quotas. | |
| `/dev/sdb` as the device formatted as EXT4 enabling only project quotas. |
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 29, Replace the misspelled word
"formated" with "formatted" in the sentence referencing `/dev/sdb` and EXT4 so
it reads "`/dev/sdb` as the device formatted as EXT4 enabling only project
quotas."
| `mkfs.ext4` will format the disk with the ext4 filesystem | ||
| * The `O` flag is the enable Feature Options | ||
| - enable quotas while formatting | ||
| * The `E` flag is for Extented Options |
There was a problem hiding this comment.
Fix spelling error.
"Extented" should be "Extended".
📝 Proposed fix
- * The `E` flag is for Extented Options
+ * The `E` flag is for Extended Options📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * The `E` flag is for Extented Options | |
| * The `E` flag is for Extended Options |
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 38, The bullet text "* The `E`
flag is for Extented Options" contains a spelling mistake; update the string to
read "* The `E` flag is for Extended Options" (locate and edit the list item
containing `E` flag in the docs/guides/disk-quotas/ext4-xfs.mdx content).
| ``` | ||
|
|
||
| ### set quota limits | ||
| The built in quota management uses blocks by default. |
There was a problem hiding this comment.
Fix hyphenation in compound adjective.
The phrase "built in quota management" should use a hyphen: "built-in quota management".
📝 Proposed fix
-The built in quota management uses blocks by default.
+The built-in quota management uses blocks by default.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The built in quota management uses blocks by default. | |
| The built-in quota management uses blocks by default. |
🧰 Tools
🪛 LanguageTool
[grammar] ~177-~177: Use a hyphen to join words.
Context: ...cf9a ``` ### set quota limits The built in quota management uses blocks by defau...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 177, The phrase "built in quota
management" should be corrected to use a hyphenated compound adjective: replace
"built in quota management" with "built-in quota management" wherever it appears
(for example in the sentence currently reading "The built in quota management
uses blocks by default.") to ensure proper hyphenation.
| The `setquota` command sets the quota for any object that supports quotas. | ||
| * The `P` flag sets the quota for a project | ||
| - This can use the project `id` or `name` | ||
| - The should be the server UUID as shown in the examples below |
There was a problem hiding this comment.
Fix grammatical error.
"The should be" appears to be a typo. Should be "This should be" for proper grammar.
📝 Proposed fix
- - The should be the server UUID as shown in the examples below
+ - This should be the server UUID as shown in the examples below📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - The should be the server UUID as shown in the examples below | |
| - This should be the server UUID as shown in the examples below |
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 183, Replace the typo "The
should be the server UUID as shown in the examples below" with "This should be
the server UUID as shown in the examples below"—update the sentence text in
docs/guides/disk-quotas/ext4-xfs.mdx where that exact phrase appears.
| The `repquota` command will generate a report on the quotas for the specified device or mount path | ||
| * The `P` flag will break down the report by project. | ||
| - In this case it should be the server UUID that is the project name | ||
| * The `--human-readable` flag sets the limits to be displayed in a human readable format. By default that is Megabytes |
There was a problem hiding this comment.
Fix hyphenation in compound adjective.
The phrase "human readable format" should use a hyphen: "human-readable format".
📝 Proposed fix
-* The `--human-readable` flag sets the limits to be displayed in a human readable format. By default that is Megabytes
+* The `--human-readable` flag sets the limits to be displayed in a human-readable format. By default that is Megabytes📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * The `--human-readable` flag sets the limits to be displayed in a human readable format. By default that is Megabytes | |
| * The `--human-readable` flag sets the limits to be displayed in a human-readable format. By default that is Megabytes |
🧰 Tools
🪛 LanguageTool
[grammar] ~204-~204: Use a hyphen to join words.
Context: ...ts the limits to be displayed in a human readable format. By default that is Mega...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
In @docs/guides/disk-quotas/ext4-xfs.mdx at line 204, The phrase "human readable
format" in the documentation should be hyphenated as a compound adjective;
update the sentence containing "`--human-readable` flag sets the limits to be
displayed in a human readable format. By default that is Megabytes`" to use
"human-readable format" (i.e., replace "human readable format" with
"human-readable format") so it reads "`--human-readable` flag sets the limits to
be displayed in a human-readable format. By default that is Megabytes`".
Updates the container width to fill more of the screen. This is better for the standard widescreen layouts.
Add docker to the additionalLanguages for prism.
Adds an "About Quotas" page with warnings.
Adds documentation on enabling filesystem based quotas for EXT4.
Adds Docs on advanced quota management section that covers EXT4.
Adds empty pages for other filesystems is support is added.
Summary by CodeRabbit
Documentation
Style
Improvements
✏️ Tip: You can customize this high-level summary in your review settings.