Skip to content

Add Quota Documentation#186

Merged
parkervcp merged 3 commits intomainfrom
advanced_configs_quotas
Feb 2, 2026
Merged

Add Quota Documentation#186
parkervcp merged 3 commits intomainfrom
advanced_configs_quotas

Conversation

@parkervcp
Copy link
Contributor

@parkervcp parkervcp commented Jan 8, 2026

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

    • Added comprehensive disk quota guides for EXT4/XFS and an "About Quotas" overview
    • Updated installation docs with a tip to keep server files on a separate partition
    • Reorganized docs navigation to surface a Disk Quotas section
  • Style

    • Updated container width tokens for improved page layout and readability

✏️ Tip: You can customize this high-level summary in your review settings.

@netlify
Copy link

netlify bot commented Jan 8, 2026

Deploy Preview for pelica ready!

Name Link
🔨 Latest commit a4eabb7
🔍 Latest deploy log https://app.netlify.com/projects/pelica/deploys/697ffe045c5d740008685531
😎 Deploy Preview https://deploy-preview-186--pelica.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link

coderabbitai bot commented Jan 8, 2026

📝 Walkthrough

Walkthrough

Adds two disk-quota documentation pages, updates the site sidebar (removes Eggs, nests Disk Quotas under Guides), tweaks an install link and admonition, and adjusts two container width CSS variables.

Changes

Cohort / File(s) Summary
Install doc
docs/wings/install.mdx
Added a tip recommending server files be on a separate partition; corrected SSL admonition link from ./../guides/ssl to ../guides/ssl.
Sidebar config
sidebars.ts
Removed top-level Eggs category; added a nested Disk Quotas category under Guides containing guides/disk-quotas/about and guides/disk-quotas/ext4-xfs.
Styling
src/css/custom.scss
Added CSS custom properties: --ifm-container-width-xl: 1600px and --ifm-container-width: 1280px.
Disk Quotas docs
docs/guides/disk-quotas/about.mdx, docs/guides/disk-quotas/ext4-xfs.mdx
Added two new guide pages: an overview of quotas with admonitions and a detailed EXT4/XFS quota configuration and management guide (interactive tabs, commands, warnings).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I thumped a note about space and size,
New quota guides where knowledge lies,
Eggs hopped away, a sidebar shift,
Widths stretched out—a tidy gift,
I nibble docs and dance with delight.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add Quota Documentation' directly summarizes the main change: introducing new documentation pages for disk quotas (about.mdx and ext4-xfs.mdx) and related sidebar navigation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch advanced_configs_quotas

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0be4f88 and a4eabb7.

📒 Files selected for processing (2)
  • docs/guides/disk-quotas/about.mdx
  • docs/guides/disk-quotas/ext4-xfs.mdx
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-02-02T01:29:01.167Z
Learnt from: parkervcp
Repo: pelican-dev/docs PR: 186
File: docs/guides/disk-quotas/ext4-xfs.mdx:176-192
Timestamp: 2026-02-02T01:29:01.167Z
Learning: In the Pelican docs repo (pelican-dev/docs), trailing slashes on device paths (e.g., /dev/sdb/) in the disk quotas guidance should not be flagged. Accept both forms and ensure this exception is only applied to device path examples in documentation; maintain standard validation for other content.

Applied to files:

  • docs/guides/disk-quotas/ext4-xfs.mdx
  • docs/guides/disk-quotas/about.mdx
🪛 LanguageTool
docs/guides/disk-quotas/ext4-xfs.mdx

[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)

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)

🔇 Additional comments (2)
docs/guides/disk-quotas/about.mdx (1)

1-29: LGTM!

The documentation page is well-structured with appropriate admonitions that clearly warn users about the risks and status of disk quota support. The cross-reference link to the EXT4/XFS page is correct.

docs/guides/disk-quotas/ext4-xfs.mdx (1)

32-124: Well-structured tabbed content for filesystem configuration.

The two-tab approach (New vs Existing EXT4 Filesystem) provides clear, distinct workflows. The fstab examples with UUIDs and mount options are practical and correctly formatted.

✏️ Tip: You can disable this entire section by setting review_details to false in your review 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 804b8e4 and 16a9f20.

📒 Files selected for processing (9)
  • docs/guides/disk-quotas/about.mdx
  • docs/guides/disk-quotas/btrfs.mdx
  • docs/guides/disk-quotas/ext4-xfs.mdx
  • docs/guides/disk-quotas/lvm.mdx
  • docs/guides/disk-quotas/zfs.mdx
  • docs/wings/install.mdx
  • docusaurus.config.ts
  • sidebars.ts
  • src/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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 16a9f20 and ccf26b7.

📒 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@docs/eggs/creating-a-custom-egg.mdx`:
- Around line 197-210: In the "## List of Default Variables" section replace the
incorrect sentence "Below are an example of a few" with a grammatically correct
phrasing (e.g., "Below are a few examples." or "Below is an example of a few.")
so the subject-verb agreement is fixed; locate the sentence immediately
following the heading and update it accordingly.

In `@docs/guides/php-upgrade.mdx`:
- Around line 68-70: The sed command in the docs uses an incorrect character
class "[7|8]" which matches a literal pipe; update the sed expression used in
the PHP upgrade guide (the string "sed -i -e
's/php[7|8].[0-9]-fpm.sock/php8.5-fpm.sock/' /etc/caddy/Caddyfile") to use
"[78]" instead of "[7|8]" so it properly matches PHP 7.x or 8.x socket
filenames.
- Around line 44-46: The sed commands using the regex pattern
"php[7|8].[0-9]-fpm.sock" (seen in the nginx replacement) and the analogous
Caddy sed command use a character class with a literal pipe; change the
character class from [7|8] to [78] so the pattern becomes
"php[78].[0-9]-fpm.sock" to correctly match PHP 7 or 8 versions.
🧹 Nitpick comments (5)
docs/panel/advanced/plugins.mdx (1)

214-236: Code example is missing use statements for Route facade and TestController.

Users following this example will encounter errors since the Route facade and TestController class are referenced but not imported. Consider adding the necessary imports for completeness:

📝 Suggested improvement
 ```php
 use Illuminate\Foundation\Support\Providers\RouteServiceProvider;
+use Illuminate\Support\Facades\Route;

 class MyPluginRoutesProvider extends RouteServiceProvider
 {
     public function boot(): void
     {
         $this->routes(function () {
-            // Single new endpoint with Controller
-            Route::get('test', [TestController::class, 'test'])->name('my-plugin.test');
+            // Single new endpoint with Controller (replace with your actual controller)
+            Route::get('test', [\MyPlugin\Http\Controllers\TestController::class, 'test'])->name('my-plugin.test');

             // Load routes from file
docs/guides/php-upgrade.mdx (1)

19-20: Minor style suggestion: simplify phrasing.

Per static analysis, "In order to install" could be simplified to "To install" for conciseness.

Suggested change
-In order to install PHP 8.5, you will need to run the following commands. Please keep in mind different operating systems
+To install PHP 8.5, you will need to run the following commands. Please keep in mind different operating systems
docs/eggs/creating-a-custom-yolk.mdx (1)

81-104: Minor inconsistency: text says apt-get but code uses apt.

Line 83 mentions "Ubuntu's package manager: apt-get" but the code block shows apt commands. While both work, the documentation should be consistent with the code example.

📝 Suggested fix
-The next thing we do is install the dependencies we will need using Ubuntu's package manager: `apt-get`. To keep things clean everything is being contained in a single [`RUN`](https://docs.docker.com/engine/reference/builder/#run) block.
+The next thing we do is install the dependencies we will need using Ubuntu's package manager: `apt`. To keep things clean everything is being contained in a single [`RUN`](https://docs.docker.com/engine/reference/builder/#run) block.
sidebars.ts (2)

48-55: Indentation inconsistency.

The Eggs category block uses 3-space indentation for the opening brace, while other categories (Panel, Wings, Guides) use 4-space indentation. Consider aligning for consistency.

📝 Suggested fix
-   {
+    {
       type: 'category',
       label: 'Eggs',
       items: [
         'eggs/creating-a-custom-egg',
         'eggs/creating-a-custom-yolk',
       ],
     },

67-75: Extra whitespace before nested category.

Line 67 has trailing whitespace before the Disk Quotas category definition. Minor cleanup opportunity.

📝 Suggested fix
         'guides/uninstalling',
-      
         {
           type: 'category',
           label: 'Disk Quotas',
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ccf26b7 and 4c2084b.

📒 Files selected for processing (11)
  • docs/eggs/creating-a-custom-egg.mdx
  • docs/eggs/creating-a-custom-yolk.mdx
  • docs/guides/php-upgrade.mdx
  • docs/panel/advanced/plugins.mdx
  • docs/panel/getting-started.mdx
  • docs/panel/panel-setup.mdx
  • docs/panel/update.mdx
  • docs/panel/webserver-config.mdx
  • docs/wings/install.mdx
  • docusaurus.config.ts
  • sidebars.ts
✅ Files skipped from review due to trivial changes (1)
  • docs/panel/panel-setup.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/wings/install.mdx
  • docusaurus.config.ts
🧰 Additional context used
🪛 LanguageTool
docs/guides/php-upgrade.mdx

[style] ~18-~18: Consider a more concise word here.
Context: ...| 8.2, 8.3, 8.4, 8.5 | ## Install PHP In order to install PHP 8.5, you will need to run t...

(IN_ORDER_TO_PREMIUM)

docs/eggs/creating-a-custom-egg.mdx

[style] ~57-~57: Try moving the adverb to make the sentence clearer.
Context: ...ame implies, this should be the command used to safely stop the server. For some games, this is stop or `end...

(SPLIT_INFINITIVE)


[style] ~69-~69: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...scriptor. Wings will process this block prior to booting the server to ensure all of the...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[style] ~69-~69: Consider removing “of” to be more concise
Context: ...k prior to booting the server to ensure all of the required settings are defined and set c...

(ALL_OF_THE)


[style] ~191-~191: Consider an alternative for the often overused word ‘important’.
Context: ...file to perform actions, thus it is not important for the user to see. Finally, you will...

(NOT_IMPORTANT)


[style] ~193-~193: Consider removing “of” to be more concise
Context: ...10 characters in length. You can find all of the available validation rules in the [Lara...

(ALL_OF_THE)

docs/eggs/creating-a-custom-yolk.mdx

[grammar] ~5-~5: Ensure spelling is correct
Context: ...ks) docker image, which can be found on GitHub. This tutorial also assumes some knowle...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[style] ~12-~12: Consider a more concise word here.
Context: ...org) as much as possible for our images in order to keep their size down. But for my exampl...

(IN_ORDER_TO_PREMIUM)


[style] ~151-~151: Consider an alternative adverb to strengthen your wording.
Context: ...ccumulating when child processes aren't properly cleaned up :::warning Sometimes you ma...

(PROPERLY_THOROUGHLY)


[style] ~158-~158: Consider a more concise word here.
Context: ... is located. ::: ## Entrypoint Script In order to complete this Dockerfile, we will nee...

(IN_ORDER_TO_PREMIUM)

🔇 Additional comments (14)
docs/panel/advanced/plugins.mdx (2)

370-373: LGTM!

The License admonition content is clear and provides helpful guidance on licensing options for plugin developers.


210-212: Good addition of the Routes documentation section.

The Routes subsection fills an important gap in the plugin documentation by showing how to register custom routes. The three example patterns (single endpoint, file-based routes, and API client routes) cover common use cases well.

docs/panel/getting-started.mdx (1)

48-49: LGTM!

PHP 8.5 released on November 20, 2025, so recommending it as the primary version with 8.4/8.3/8.2 as alternatives is appropriate and consistent with the other documentation updates in this PR.

docs/panel/update.mdx (1)

15-17: LGTM!

The version requirements table is properly updated to include PHP 8.5 alongside existing supported versions. This is consistent with the other documentation changes in this PR.

docs/panel/webserver-config.mdx (3)

15-15: LGTM!

The Nginx configuration updates correctly reference php8.5-fpm.sock with proper unix:/run/php/php8.5-fpm.sock syntax.

Also applies to: 78-78, 128-128


233-241: LGTM!

The Apache configuration updates are consistent, updating both the admonition warning and the a2enmod php8.5 command.


253-256: LGTM!

The Caddy configuration updates correctly use unix//run/php/php8.5-fpm.sock syntax (Caddy's unix socket format differs from Nginx's unix: prefix).

Also applies to: 284-284, 337-337

docs/guides/php-upgrade.mdx (3)

13-15: LGTM!

The PHP version table correctly lists all supported versions (8.2, 8.3, 8.4, 8.5) for Panel Version 1.0.0+.


30-31: LGTM!

The installation commands correctly reference php8.5 and the required extensions.


55-59: LGTM!

The Apache configuration instructions correctly update from disabling all previous PHP versions to enabling php8.5.

docs/eggs/creating-a-custom-yolk.mdx (1)

1-215: Well-structured Docker documentation.

The documentation thoroughly covers the yolk creation process with clear explanations of:

  • Platform architecture considerations with TARGETOS/TARGETARCH
  • The required container user setup and /home/container directory
  • Tini as init process with proper signal handling
  • The startup command variable substitution mechanism
docs/eggs/creating-a-custom-egg.mdx (2)

139-173: Excellent variable reference documentation.

The clear distinction between variable syntax in different contexts (startup commands vs configuration parsers vs install scripts) is very helpful for users. The note block on lines 168-173 effectively summarizes the key differences.


259-263: Important warning about install container path.

Good call highlighting that install scripts run in /mnt/server rather than /home/container. This is a common source of confusion for new egg developers.

sidebars.ts (1)

48-75: Sidebar structure additions look good.

The new Eggs category and Disk Quotas subcategory are properly structured and correspond to the new documentation files added in this PR.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Copy link
Member

@lancepioch lancepioch left a comment

Choose a reason for hiding this comment

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

Not blockers but would love if these were applied, thanks!

I am not fighting with the eggs main as well
@parkervcp parkervcp force-pushed the advanced_configs_quotas branch from ffa41e5 to eceea2b Compare February 1, 2026 22:26
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 8

🤖 Fix all issues with AI agents
In `@disk-quotas/about.mdx`:
- Around line 6-8: The Admonition text in disk-quotas/about.mdx contains a
sentence fragment ("As called out in the Wings install docs. It is always...");
update the Admonition content so the two parts are joined into a single sentence
(e.g., "As called out in the Wings install docs, it is always recommended to
keep the server files on a separate partition.") by editing the Admonition block
text to remove the period and replace with appropriate punctuation.
- Around line 28-29: Update the heading "Filesystem specific docs" to use the
hyphenated compound adjective form "Filesystem-specific docs" in the
disk-quotas/about.mdx file so the compound adjective precedes the noun
correctly; locate the heading text (the line containing "Filesystem specific
docs" and the adjacent <Link
to="/docs/guides/disk-quotas/ext4-xfs">EXT4/XFS</Link>) and replace it with
"Filesystem-specific docs".

In `@disk-quotas/ext4-xfs.mdx`:
- Line 10: Change the phrase "built in quota management services in linux" to
use the hyphenated compound adjective and capitalize the OS: replace it with
"built-in quota management services in Linux" in the disk-quotas/ext4-xfs.mdx
content (look for the exact string "built in quota management services in
linux").
- Around line 87-91: In the "Unmount disk" section update the possessive noun
"Pelicans" to "Pelican's" in the sentence that reads "Use `umount` to unmount
Pelicans volume mount." so it becomes "Use `umount` to unmount Pelican's volume
mount."; locate the sentence near the `umount /var/lib/pelican/volumes/` code
block and change only the word "Pelicans" to the correct possessive form
"Pelican's".
- Around line 176-192: Update the prose in the "set quota limits" section:
change the phrase "built in quota management" to "built-in quota management"
(fix the hyphenation) and remove the incorrect trailing slash from the device
example `/dev/sdb/` so it reads `/dev/sdb` in the `setquota` command examples
and accompanying bullet that lists the device or mount point.
- Around line 200-205: The sentence describing the flag should hyphenate the
compound adjective: change "in a human readable format" to "in a human-readable
format" in the paragraph that explains the `--human-readable` flag (referenced
by the literal `--human-readable` in the diff) so the compound adjective is
properly formed.
- Around line 28-41: Fix the two spelling mistakes in the documentation: change
"formated" to "formatted" in the description that mentions `/dev/sdb` and change
"Extented" to "Extended" in the bullet describing the `E` flag; ensure the
surrounding text referencing `mkfs.ext4`, the `-O` and `-E` flags, and the
mount/data path `/var/lib/pelican/volumes/` remains unchanged.
- Around line 139-140: Fix the typo in the "Manually Manage Quotas" section:
change the word "assinged" to "assigned" in the sentence "Limits for the servers
are managed on a "project" level so they can be assinged per-directory." so it
reads "...so they can be assigned per-directory." Locate this sentence under the
"Manually Manage Quotas" heading in disk-quotas/ext4-xfs.mdx and update the
spelling.
🧹 Nitpick comments (1)
disk-quotas/ext4-xfs.mdx (1)

224-226: TODO: XFS documentation placeholder.

There's a TODO note for adding XFS-specific documentation. The page title mentions both EXT4 and XFS, but currently only EXT4 is documented.

Would you like me to help draft the XFS-specific documentation section, or would you prefer to open an issue to track this as a follow-up task?

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffa41e5 and eceea2b.

📒 Files selected for processing (8)
  • disk-quotas/about.mdx
  • disk-quotas/btrfs.mdx
  • disk-quotas/ext4-xfs.mdx
  • disk-quotas/lvm.mdx
  • disk-quotas/zfs.mdx
  • docs/wings/install.mdx
  • sidebars.ts
  • src/css/custom.scss
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/css/custom.scss
  • docs/wings/install.mdx
🧰 Additional context used
🪛 LanguageTool
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)

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)

🔇 Additional comments (1)
sidebars.ts (1)

59-67: LGTM!

The new "Disk Quotas" category is correctly nested under "Guides" and the item paths align with the new documentation files. The structure follows the existing sidebar conventions.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

@parkervcp parkervcp merged commit e104f2c into main Feb 2, 2026
5 checks passed
@parkervcp parkervcp deleted the advanced_configs_quotas branch February 2, 2026 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants