Skip to content

Improved Documentation for Zypper and small fixes.#793

Open
PizzaLovingNerd wants to merge 3 commits into
netbirdio:mainfrom
PizzaLovingNerd:zypper
Open

Improved Documentation for Zypper and small fixes.#793
PizzaLovingNerd wants to merge 3 commits into
netbirdio:mainfrom
PizzaLovingNerd:zypper

Conversation

@PizzaLovingNerd

@PizzaLovingNerd PizzaLovingNerd commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

I ended up splitting OpenSUSE and OpenSUSE MicroOS, giving instructions to actually add the GPG key and refresh the repo, and a minor fix to add RHEL 8+ for the DNF instructions as RHEL as YUM is just a wrapper around DNF since RHEL 8.

All the OpenSUSE instructions were tested on Leap 16, Tumbleweed and MicroOS.

Summary by CodeRabbit

  • Documentation
    • Refined Linux installation instructions with improved package manager categorization (YUM, DNF 4, DNF 5, Zypper) for better clarity
    • Enhanced openSUSE MicroOS installation steps with reorganized guidance and additional post-installation configuration details

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates the Linux installation documentation to clarify package-manager distinctions and improve workflow clarity. RHEL and Amazon Linux sections are explicitly labeled by package manager (YUM vs. DNF), DNF variants are split into version-specific guidance (DNF 4 vs. 5), and openSUSE Zypper and MicroOS instructions are reorganized with improved formatting and expanded service-management steps.

Changes

Linux Installation Documentation Clarity

Layer / File(s) Summary
RPM-based distro labeling and DNF version clarity
src/pages/get-started/install/linux.mdx
Section headings updated to distinguish RHEL 7 / Amazon Linux 2 as YUM-based from RHEL 8+ / Fedora / Amazon Linux 2023 as DNF-based, with new sub-section headers separating DNF 4 (RHEL / Fedora 40 or earlier / Amazon Linux 2023) from DNF 5 (Fedora 41+).
openSUSE installation flow reorganization and expansion
src/pages/get-started/install/linux.mdx
openSUSE Zypper installation instructions are restructured with GPG/key information reformatted as bullet points and improved step formatting for repository/key import and package install. openSUSE MicroOS subsection expanded to include reboot and enabling/starting the netbird service after installation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through docs so clear,
Where YUM and DNF now appear,
With Fedora versions, neat and bright,
And openSUSE steps set right.
The MicroOS service now starts with cheer!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title mentions 'Zypper' and 'small fixes' but the PR summary shows changes span multiple package managers (DNF, YUM, Zypper) and distro labeling improvements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install timed out. The project may have too many dependencies for the sandbox.


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/pages/get-started/install/linux.mdx (1)

1-1: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Missing Warning component import.

The Warning component is used at line 182 but not imported. Update the import statement at line 1 to include Warning.

🔧 Proposed fix
-import {Note} from "`@/components/mdx`";
+import {Note, Warning} from "`@/components/mdx`";

Also applies to: 182-182

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/pages/get-started/install/linux.mdx` at line 1, The import at the top
only brings in Note but the page uses the Warning component (referenced as
Warning around line 182); update the import statement that currently imports
Note (import {Note} from "`@/components/mdx`";) to also import Warning so both
components are available (e.g., import {Note, Warning} from
"`@/components/mdx`";).

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@src/pages/get-started/install/linux.mdx`:
- Line 1: The import at the top only brings in Note but the page uses the
Warning component (referenced as Warning around line 182); update the import
statement that currently imports Note (import {Note} from "`@/components/mdx`";)
to also import Warning so both components are available (e.g., import {Note,
Warning} from "`@/components/mdx`";).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dad94d71-f857-4e99-871c-fa28934bd172

📥 Commits

Reviewing files that changed from the base of the PR and between b344041 and 2bd7f09.

📒 Files selected for processing (1)
  • src/pages/get-started/install/linux.mdx

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.

1 participant