Skip to content

Commit

Permalink
chore: format everything w/ prettier :p
Browse files Browse the repository at this point in the history
  • Loading branch information
tulilirockz committed Dec 10, 2024
1 parent 6d6bab1 commit b9e9573
Show file tree
Hide file tree
Showing 10 changed files with 48 additions and 54 deletions.
13 changes: 5 additions & 8 deletions docs/guides/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ description: Day-to-day usage guide for Aurora.
## Installing Software

| Graphical Applications | Command-Line / Terminal | Legacy Applications |
| -------- | -------- | -------- |
| Flatpak | Homebrew | Distrobox |
| ---------------------- | ----------------------- | ------------------- |
| Flatpak | Homebrew | Distrobox |

Read the [Software Guide](https://docs.getaurora.dev/guides/software/) for more information.

## Managing Installed Applications

### Flatseal

Manage Flatpak permissions thoroughly. KDE Plasma's system settings can also change permissions, but not as granular.
Manage Flatpak permissions thoroughly. KDE Plasma's system settings can also change permissions, but not as granular.

### Warehouse

Expand All @@ -26,6 +26,7 @@ Manage installed Flatpaks by downgrading, backing up user data, and adding addit
Unfortunately, due to a limitation with OCI images, there are too many downsides to recommend uninstalling the pre-installed packages that ship with Aurora without [forking the project](https://github.com/ublue-os/bluefin/fork), building your own based on our [template](https://github.com/ublue-os/image-template), or using the unaffiliated [Blue-Build](https://blue-build.org/learn/universal-blue/) project.

These downsides include:

- Longer upgrades times
- More storage will be used despite the package being removed

Expand All @@ -44,10 +45,8 @@ ujust

## Updates


System updates and applications are automatically updated on a daily schedule.


### Rolling back bad system upgrades

If a bad regression occurs during a system update, then you can rollback to the last deployment...
Expand All @@ -56,11 +55,9 @@ If a bad regression occurs during a system update, then you can rollback to the
rpm-ostree rollback
```


#### Rebasing to specific Aurora images


>**Note**: System updates are paused when you rebase to an older image until you rebase back to `:stable`
> **Note**: System updates are paused when you rebase to an older image until you rebase back to `:stable`
Use the `rebase-helper` tool for a specific image.

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/devcontainers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: DevContainers
description: A guide on devcontainers.
---
description: A guide on devcontainers.
---
4 changes: 0 additions & 4 deletions docs/guides/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Writing a good guide requires thinking about what your users are trying to do.

## How about we do this instead?





## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
15 changes: 8 additions & 7 deletions docs/guides/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,22 @@ title: Introductory Guide
description: Aurora at a glance.
slug: /
---

## Aurora

A familiar KDE desktop for people who love Fedora Kinoite. Aurora is a maintenance-free, reliable and fast operating system for everyone, stable like a Chromebook. It combines the power of Fedora and the beauty of a KDE desktop in a single, reliable and sleek package.

![Aurora](/img/aurora.jpeg)

- Developers, check out [Aurora-DX](https://docs.projectbluefin.io/bluefin-dx) for developer focused images!
- Developers, check out [Aurora-DX](https://docs.projectbluefin.io/bluefin-dx) for developer focused images!

> "The desire to reach for the stars is ambitious. The desire to reach hearts is wise." - Maya Angelou
## Features

**This image heavily utilizes _cloud-native concepts_.**

System updates are image-based and automatic. Applications are logically separated from the system by using Flatpaks for graphical applications and `brew` for command line applications. Workloads for development are containerized.
System updates are image-based and automatic. Applications are logically separated from the system by using Flatpaks for graphical applications and `brew` for command line applications. Workloads for development are containerized.

## For Users

Expand All @@ -31,10 +32,10 @@ System updates are image-based and automatic. Applications are logically separat
- [Starship](https://starship.rs) terminal prompt enabled by default
- Docker & Podman Developer Edition Images contain both Docker and Podman runtimes to support your containerized needs.
- [Input Leap](https://github.com/input-leap/input-leap) built in
- [Solaar](https://github.com/pwr-Solaar/Solaar) - included for Logitech mouse
management along with `libratbagd`
- [Solaar](https://github.com/pwr-Solaar/Solaar) - included for Logitech mouse
management along with `libratbagd`
- [rclone](https://rclone.org/) and [restic](https://restic.net/) included
- `zsh` and `fish` included (optional)
- `zsh` and `fish` included (optional)
- Built on top of the the [Universal Blue main image](https://github.com/ublue-os/main)
- Extra udev rules for game controllers and [other devices](https://github.com/ublue-os/config) included out of the box
- All multimedia codecs included
Expand All @@ -54,8 +55,8 @@ Other than the visual differences, and codecs, there are some other key differen

- Aurora takes a [greenfield approach](https://en.wikipedia.org/wiki/Greenfield_project) to Linux applications by defaulting to Flathub and `brew` by default
- Aurora doesn't recommend using Toolbx - it instead focuses on [devcontainers](https://docs.getaurora.dev/guides/devcontainers/) for declarative containerized development. You can use Podman or Docker to run and bootstrap your containers.
- Aurora *tries* to remove the need for the user to use `rpm-ostree` or `bootc` directly
- Aurora focuses on automation of OS services and upgrades instead of user interaction. Upgrades are automatic and silent, so you never have to think about it again.
- Aurora _tries_ to remove the need for the user to use `rpm-ostree` or `bootc` directly
- Aurora focuses on automation of OS services and upgrades instead of user interaction. Upgrades are automatic and silent, so you never have to think about it again.

## Starship is not for me, how do I disable it?

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/kde-themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: KDE Plasma Themes and Customization
description: A guide to customizing KDE Plasma
---

>**Note**: Do not use install themes through the system settings since they may require access to read-only root files!
> **Note**: Do not use install themes through the system settings since they may require access to read-only root files!
## Universal Instructions

Expand Down Expand Up @@ -39,7 +39,7 @@ SDDM themes can also be layered at your own risk if they are available as RPM pa

Some Flatpaks need filesystem permissions for applications that have issues with cursor themes.

>**Example**: (`~/.icons/:ro` in "Filesystem" in each problematic application or globally in Flatseal).
> **Example**: (`~/.icons/:ro` in "Filesystem" in each problematic application or globally in Flatseal).
#### Themes that require `kvantum`

Expand Down
10 changes: 7 additions & 3 deletions docs/guides/layerapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
title: Layer apps via repofiles onto the system
description: How to layer apps with rpm-ostree.
---

## Layering Fedora Packages

**WARNING**: **Layering certain packages can pause system updates until removed**!

**NOTE**: **Don't install apps as layers unless you absolutely have to!**

Layering applications with `rpm-ostree` can be quite daunting when you first look at it. See the software installation "hierarchy" from our friends over at Bazzite: <a href="https://docs.bazzite.gg/Installing_and_Managing_Software/">Software Installation Methods ranked by most recommended.</a> Specific software must layered to function properly. This applies to packages like 1Password when you want to use the SSH feature or a VPN clients like Mullvad. This guide is aiming to show you how you can install / layer apps on the system and have it update itself when the base image get's updated. To accomplish this, your app needs to have a Fedora Repository setup.
Layering applications with `rpm-ostree` can be quite daunting when you first look at it. See the software installation "hierarchy" from our friends over at Bazzite: <a href="https://docs.bazzite.gg/Installing_and_Managing_Software/">Software Installation Methods ranked by most recommended.</a> Specific software must layered to function properly. This applies to packages like 1Password when you want to use the SSH feature or a VPN clients like Mullvad. This guide is aiming to show you how you can install / layer apps on the system and have it update itself when the base image get's updated. To accomplish this, your app needs to have a Fedora Repository setup.

<sub>**Please also note that installing software as a layer will increase the time it takes for system updates to complete. While you should not notice this in day-to-day usage because the system updates silently in the background, it's still slower.**</sub>

Expand All @@ -17,24 +18,27 @@ Layering applications with `rpm-ostree` can be quite daunting when you first loo
**Example**: Mullvad VPN Software

### 1. Identify the repo file you need (if necessary)
Mullvad conveniently provides the link to the repository file directly on their website.

Mullvad conveniently provides the link to the repository file directly on their website.
In this example, the repo file is located at <a href="https://repository.mullvad.net/rpm/stable/mullvad.repo">https://repository.mullvad.net/rpm/stable/mullvad.repo</a>.

### 2. Add the repo file (if necessary)

Now we can take that URL and execute the following commands:
Now we can take that URL and execute the following commands:

```bash
cd /etc/yum.repos.d/ #Change into the repository directory
sudo wget https://repository.mullvad.net/rpm/stable/mullvad.repo #Save the repo file to the directory
```

### 3. Layering the package

`rpm-ostree` will now index the new repository and after that search for the desired application there.

With a little

```bash
rpm-ostree install mullvad-vpn
```

We have now successfully layered Mullvad on our system. Reboot the system and you should now find Mullvad in your application list.
20 changes: 10 additions & 10 deletions docs/guides/rescue-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: How to boot into Rescue & Emergency Mode on Aurora.

Fedora already has a built-in mechanism (provided by `systemd`) for booting into [rescue](https://docs.fedoraproject.org/en-US/fedora/latest/system-administrators-guide/kernel-module-driver-configuration/Working_with_the_GRUB_2_Boot_Loader/#sec-Booting_to_Rescue_Mode) and [emergency](https://docs.fedoraproject.org/en-US/fedora/latest/system-administrators-guide/kernel-module-driver-configuration/Working_with_the_GRUB_2_Boot_Loader/#sec-Booting_to_Emergency_Mode) modes.

However, those documents have limitations as by default, Fedora (and thus Universal Blue systems), do not set a `root` password during install. Thus, when the emergency or rescue mode is reached, the user is shown the error:
However, those documents have limitations as by default, Fedora (and thus Universal Blue systems), do not set a `root` password during install. Thus, when the emergency or rescue mode is reached, the user is shown the error:

```
Cannot open access to console, the root account is locked.
```

### We've improved the situation for all *Universal Blue* derivatives (including *Bazzite* and *Bluefin*) using inspiration from *Fedora CoreOS*.
### We've improved the situation for all _Universal Blue_ derivatives (including _Bazzite_ and _Bluefin_) using inspiration from _Fedora CoreOS_.

Now, when booting to [emergency](#booting-to-emergency-mode-2) or [rescue](#booting-to-rescue-mode-3) mode with a locked root account, the user is instead presented a more standard prompt:

Expand All @@ -31,13 +31,13 @@ See below for more details:
Emergency mode provides the most minimal environment possible and allows you to repair your system even in situations when the system is unable to enter rescue mode. In emergency mode, the system mounts the `root` file system only for reading, does not attempt to mount any other local file systems, does not activate network interfaces, and only starts few essential services.

1. Press <kbd>Esc</kbd> on the keyboard to reach the GRUB boot menu.
a. If you press <kbd>Esc</kbd> too many times, you may end up at a `grub>` prompt.
b. Return to the boot menu by typing `exit` and pressing <kbd>Enter</kbd>
a. If you press <kbd>Esc</kbd> too many times, you may end up at a `grub>` prompt.
b. Return to the boot menu by typing `exit` and pressing <kbd>Enter</kbd>
2. Select the desired deployment (the top entry is generally correct) and edit by pressing <kbd>E</kbd> on the keyboard.
3. Arrow down to the line starting with `linux` and press <kbd>Ctrl</kbd>+<kbd>E</kbd> to reach the end of the line.
4. Add the word `emergency` to the end of the line.
a. Ensure there is a space between `emergency` and the pre-existing text.
b. Equivalent parameters `-b` and `systemd.unit=emergency.target` may be added instead of `emergency`.
a. Ensure there is a space between `emergency` and the pre-existing text.
b. Equivalent parameters `-b` and `systemd.unit=emergency.target` may be added instead of `emergency`.
5. Press <kbd>Ctrl</kbd>+<kbd>X</kbd> to boot the system.

---
Expand All @@ -47,13 +47,13 @@ Emergency mode provides the most minimal environment possible and allows you to
Rescue mode provides a convenient single-user environment and allows you to repair your system in situations when it is unable to complete a normal booting process. In rescue mode, the system attempts to mount all local file systems and start some important system services, but it does not activate network interfaces or allow more users to be logged into the system at the same time. In Fedora, rescue mode is equivalent to single user mode.

1. Press <kbd>Esc</kbd> on the keyboard to reach the GRUB boot menu.
a. If you press <kbd>Esc</kbd> too many times, you may end up at a `grub>` prompt.
b. Return to the boot menu by typing `exit` and pressing <kbd>Enter</kbd>
a. If you press <kbd>Esc</kbd> too many times, you may end up at a `grub>` prompt.
b. Return to the boot menu by typing `exit` and pressing <kbd>Enter</kbd>
2. Select the desired deployment (the top entry is generally correct) and edit by pressing <kbd>E</kbd> on the keyboard.
3. Arrow down to the line starting with `linux` and press <kbd>Ctrl</kbd>+<kbd>E</kbd> to reach the end of the line.
4. Add the word `single` to the end of the line.
a. Ensure there is a space between `single` and the pre-existing text.
b. Equivalent parameters `1`, `s`, `S`, and `systemd.unit=rescue.target` may be added instead of `single`.
a. Ensure there is a space between `single` and the pre-existing text.
b. Equivalent parameters `1`, `s`, `S`, and `systemd.unit=rescue.target` may be added instead of `single`.
5. Press <kbd>Ctrl</kbd>+<kbd>X</kbd> to boot the system.

---
Expand Down
5 changes: 2 additions & 3 deletions docs/guides/software.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: How to install software on Aurora

## Flatpak

[Flatpak](https://www.flatpak.org/) is the primary package method for graphical applications. By default, the [Flathub](https://www.flathub.org) remote is used which contains several popular applications to install from. Install Flatpaks with the **Discover** application.
[Flatpak](https://www.flatpak.org/) is the primary package method for graphical applications. By default, the [Flathub](https://www.flathub.org) remote is used which contains several popular applications to install from. Install Flatpaks with the **Discover** application.

## Homebrew

Expand All @@ -15,15 +15,14 @@ The [Homebrew](https://brew.sh/) package manager is specifically for installing

[Distrobox](https://distrobox.it/) containers are Linux subsystems of other popular Linux distributions which give users access to their package managers (like `dnf` or `apt`) and their package formats (like RPM and Deb).


They are commonly used for two different scenarios:

- Used as a fallback for "legacy Linux software" that does not have a Flatpak available
- Development boxes

## `rpm-ostree`

>**Note**: It is highly recommended to only use this as a last resort.
> **Note**: It is highly recommended to only use this as a last resort.
Layer RPM packages to the host like a traditional Linux operating system which comes with major downsides such as:

Expand Down
9 changes: 4 additions & 5 deletions docs/guides/start-icon.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ description: How to change your start icon
Updating your start icon in Aurora is a straight-forward process. You'll have access to both a sleek white version and a vibrant, colorful option to customize your experience. By default, the colorful version is selected.

1. Firstly, open the settings for the application launcher. This can be done by right clicking the application launcher icon on your taskbar. It will show a menu, select "Configure Application Launcher".
![First step](/img/start-icon-change/screen-1.png)
![First step](/img/start-icon-change/screen-1.png)

2. In the screen that opens, click on the Aurora Logo Button and then click "Choose". This will open another window with lots of icons.
![First step](/img/start-icon-change/screen-2.png)
2. In the screen that opens, click on the Aurora Logo Button and then click "Choose". This will open another window with lots of icons.
![First step](/img/start-icon-change/screen-2.png)

3. Last step: In the dropdown on the left, select "**All icons**" from the list. Then type in "**distributor**" in the search / input field and you should see the two logos that are currently included by default with your Aurora installation.
![First step](/img/start-icon-change/screen-3.png)

![First step](/img/start-icon-change/screen-3.png)

That's it! You've successfully changed your icon. Also, you can also select custom icons here if you search for them via the file picker. 😉 (Click on the browse button on the bottom left).
18 changes: 8 additions & 10 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,20 @@ const sidebars: SidebarsConfig = {
label: "Guides",
collapsed: false,
items: [
'guides/start-icon',
'guides/basic-usage',
'guides/software',
'guides/layerapp',
'guides/developer',
'guides/devcontainers',
'guides/rescue-mode',
"guides/start-icon",
"guides/basic-usage",
"guides/software",
"guides/layerapp",
"guides/developer",
"guides/devcontainers",
"guides/rescue-mode",
],
},
{
type: "category",
label: "Reference",
collapsed: false,
items: [
'reference/example'
],
items: ["reference/example"],
},
],
};
Expand Down

0 comments on commit b9e9573

Please sign in to comment.