fix: fix community links; run lint on md file (#701)

* fix: fix community links; run lint on md file * fix: md lint fixes
ublue-os · Jan 24, 2024 · 74a72ca · 74a72ca
1 parent f250715
commit 74a72ca
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 37 deletions.
diff --git a/docs/images.md b/docs/images.md
@@ -12,9 +12,11 @@ This list is in alphabetical order.
 ## Preparing to Rebase
 
 1. Optional: it is recommended that you pin your current ostree image to make sure you can roll back if you change your mind using:
-    ```
+
+    ```sh
    sudo ostree admin pin <index: number>
-   ```   
+   ```
+
    For example pinning the deployment at index 0 by running `sudo ostree admin pin 0`
 
 2. `rpm-ostree reset` will remove all your layered packages and prepare for rebasing.
@@ -35,24 +37,25 @@ This list is in alphabetical order.
 After you have rebooted, switch to the signed image by running one of the commands below for the image you want. If you're already on the signed image then switching over should be a quick rebase, and then reboot.
 
 ## Image Categorization
+
 - Featured Images
-    - [Bluefin](https://github.com/ublue-os/bluefin)
-    - [Bazzite](https://github.com/ublue-os/bazzite/)
-    - [Beyond](https://github.com/ublue-os/beyond)
+  - [Bluefin](https://github.com/ublue-os/bluefin)
+  - [Bazzite](https://github.com/ublue-os/bazzite/)
+  - [Beyond](https://github.com/ublue-os/beyond)
 - Opinionated Fedora Silverblue Images
-    - More information on changes from stock Fedora Silverblue [here](/images/main/). 
-    - Offers different desktop environments and window managers if desired.
-    - Download the ISO for all different desktop variants [here](https://github.com/ublue-os/main/releases).
+  - More information on changes from stock Fedora Silverblue [here](/images/main/).
+  - Offers different desktop environments and window managers if desired.
+  - Download the ISO for all different desktop variants [here](https://github.com/ublue-os/main/releases).
 - Specialized Hardware
-    - Unique images for specific hardware (Framework, Surface, etc.)
-    -  Overlaps with the other images.
-        -  `bazzite-framework` as an example.
-- [[Community Images](https://github.com/ublue-os/awesome-custom-images)](https://universal-blue.discourse.group/t/list-of-community-created-custom-images/340)
-    - You can make your own too!  Check out [Making Your Own](/tinker/make-your-own/) and [Forking Your Own](/guide/fork-your-own/).
+  - Unique images for specific hardware (Framework, Surface, etc.)
+  - Overlaps with the other images.
+    - `bazzite-framework` as an example.
+- [Community Images](https://universal-blue.discourse.group/t/list-of-community-created-custom-images/340)
+  - You can make your own too!  Check out [Making Your Own](/tinker/make-your-own/) and [Forking Your Own](/guide/fork-your-own/).
 - Other images
-    - Base images that include only the necessary Fedora packages as a starting point.
-    - Images without kernel modules or kernel packages.
-    - Images intended only for use inside of another image and **not** installed by itself on a desktop.
+  - Base images that include only the necessary Fedora packages as a starting point.
+  - Images without kernel modules or kernel packages.
+  - Images intended only for use inside of another image and **not** installed by itself on a desktop.
 
 ## Image List
 

diff --git a/docs/index.md b/docs/index.md
@@ -9,7 +9,7 @@ This is a collection of container images using Fedora's support for OCI/Docker c
 
 For a more in-depth explanation, refer to our [Documentation,](/introduction) and [Media Coverage](/media) sections.
 
-This project provides ... 
+This project provides ...
 
 <div class="grid cards" markdown>
 
@@ -38,22 +38,22 @@ This project provides ...
 Our images offer GNOME, KDE, XFCE, LXQt, Budgie, and MATE, with more being [added regularly](/images). Our [NVIDIA images](/images/nvidia) offer a unique blend of reliability and ease of use that you won't find anywhere else. These are offered in a variety of images to fit your needs:
 
 - [Asus](/images/asus) - Fedora-based images with [asus-linux.org](https://asus-linux.org) kernels
-- [Framework](/images/framework) - Framework's recommended Fedora settings 
+- [Framework](/images/framework) - Framework's recommended Fedora settings
 - [Surface](/images/surface) - Fedora-based images with [linux-surface](https://github.com/linux-surface/linux-surface) kernels
 
-Check out [Bazzite](https://bazzite.gg), the ultimate gaming setup for your PC, Steam Deck, ASUS ROG Ally and Legion Go. Fedora's upstream pipeline automated directly to your device, nice. 
+Check out [Bazzite](https://bazzite.gg), the ultimate gaming setup for your PC, Steam Deck, ASUS ROG Ally and Legion Go. Fedora's upstream pipeline automated directly to your device, nice.
 
 [Bluefin](https://universal-blue.discourse.group/c/bluefin/6) is a simple to use desktop with the mission of serving a mass audience. The [Bluefin DX](https://universal-blue.discourse.group/t/bluefin-dx-the-bluefin-developer-experience/39) edition is designed to be the ultimate Linux workstation for open source developers.
 
-And last, but not least, check out [Beyond](https://github.com/ublue-os/beyond), our collaboration with [Cassidy James Blaede](https://cassidyjames.com/), a peek into his vision of a future GNOME desktop. 
+And last, but not least, check out [Beyond](https://github.com/ublue-os/beyond), our collaboration with [Cassidy James Blaede](https://cassidyjames.com/), a peek into his vision of a future GNOME desktop.
 
 ## Why would I use these?
 
 These images reflect a more [cloud-native](https://en.wikipedia.org/wiki/Cloud-native_computing) approach to running Linux on your desktop. We feel that a dedicated group of enthusiasts can automate a large amount of toil that plagues existing Linux desktops today. This is achieved by reusing cloud technologies as a delivery mechanism to deliver a more reliable experience. To quote the [goals of bootc](https://github.com/containers/bootc):
 
 > A toplevel goal is that every tool and technique a Linux system administrator knows around how to build, inspect, mirror and manage application containers also applies to bootable host systems.
 
-We like the sound of that, and we're hoping to be your "Desktop DevOps team". Bringing the patterns from the server world to the desktop world means that there is a new layer on top of the distribution. You can now atomically share maintenance of things that people currently do by hand as post-installation. Universal Blue automates that. Contributors use a [gitops approach](https://github.com/open-gitops/documents/blob/main/PRINCIPLES.md) to maintaining these images, all out in the open for everyone to inspect, resulting in a system that now leverages the expertise of system administrators right to your desktop. It's pretty awesome. 
+We like the sound of that, and we're hoping to be your "Desktop DevOps team". Bringing the patterns from the server world to the desktop world means that there is a new layer on top of the distribution. You can now atomically share maintenance of things that people currently do by hand as post-installation. Universal Blue automates that. Contributors use a [gitops approach](https://github.com/open-gitops/documents/blob/main/PRINCIPLES.md) to maintaining these images, all out in the open for everyone to inspect, resulting in a system that now leverages the expertise of system administrators right to your desktop. It's pretty awesome.
 
 If you want to learn, come hang out. We are here to teach and learn from each other!
 
@@ -79,45 +79,45 @@ Our goal is to for one install to last the life of the hardware.
 
 - Reliable, atomic updates with built in rollback
 - Known-good state and fewer failures:
-    - Significantly reduced configuration drift
-    - No compiling or building Nvidia drivers on the local client, they come pre-made on the image
-    - [Kernel mods](https://github.com/ublue-os/akmods) right on the image 
+  - Significantly reduced configuration drift
+  - No compiling or building Nvidia drivers on the local client, they come pre-made on the image
+  - [Kernel mods](https://github.com/ublue-os/akmods) right on the image
 - Clean separation of the base system from applications and your data
-    - Integration of Flatpak applications via [Flathub](https://flathub.org/home).
-    - [Toolbox](https://github.com/containers/toolbox) and [Distrobox](https://github.com/89luca89/distrobox) support, run applications from any distribution in a containerized environment
+  - Integration of Flatpak applications via [Flathub](https://flathub.org/home).
+  - [Toolbox](https://github.com/containers/toolbox) and [Distrobox](https://github.com/89luca89/distrobox) support, run applications from any distribution in a containerized environment
 - Unbridled customization:
-    - Craft your perfect image from scratch or derive from others
+  - Craft your perfect image from scratch or derive from others
 - Community Maintained
-    - The project is maintained by a community of cloud-native contributors with an [explicit mission](/mission)
+  - The project is maintained by a community of cloud-native contributors with an [explicit mission](/mission)
 - Reuses standards-based tooling from cloud:
-    - Built using ostree-enabled [OCI compliant images](https://opencontainers.org/)
+  - Built using ostree-enabled [OCI compliant images](https://opencontainers.org/)
 - Built-in container tools for developers:
-    - Consume packages and software from any repo without risking breakage on the client
-    - Easy consumption of other OCI images, if it's on the [CNCF Landscape](https://landscape.cncf.io/) it's a first class citizen thanks to Podman!
+  - Consume packages and software from any repo without risking breakage on the client
+  - Easy consumption of other OCI images, if it's on the [CNCF Landscape](https://landscape.cncf.io/) it's a first class citizen thanks to Podman!
 
 !!! example "What we mean by reliability:"
 
     An important concept with this model is that the system is designed to reliably deliver your software. Software bugs and issues still occur with individual software. We mean reliability when it comes to installation and upgrades of the entire system, if you were destined to get a kernel bug that day, it still happens. This might sound counterintuitive at first, but be level of efficiency improves so dramatically over the long term that it allows developers to catch issues earlier in the testing process. This is awesome stuff, ask your local cloud nerd.  
 
 ### Other Features
 
-- Rebase back to pure [Fedora](https://getfedora.org/en/) without reinstallation. This is why we don't call it a distribution, it's an atomic layer of customization on an existing distribution that can be removed. 
+- Rebase back to pure [Fedora](https://getfedora.org/en/) without reinstallation. This is why we don't call it a distribution, it's an atomic layer of customization on an existing distribution that can be removed.
 - Fast updates: minimum of once-a-day updates so you're never behind Fedora.
 - Hosted on ghcr.io:
-    - Ninety (90) days of image archives allowing for flexible rollback options.
-    - Globally distributed via CDN for fast image downloads, thanks Microsoft!
+  - Ninety (90) days of image archives allowing for flexible rollback options.
+  - Globally distributed via CDN for fast image downloads, thanks Microsoft!
 - Images signed with standard [sigstore tools](https://www.sigstore.dev/).
 - And some more features explained here:
 
 <iframe width="560" height="315" src="https://www.youtube.com/embed/X8h304Jp9N8?start=435" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>  
 
 ## Join Us
 
-We're always looking for people to help, all skill levels and areas of expertise are welcome. Check out [the roadmap](https://github.com/orgs/ublue-os/projects/1) to get a feel for the project, then: 
+We're always looking for people to help, all skill levels and areas of expertise are welcome. Check out [the roadmap](https://github.com/orgs/ublue-os/projects/1) to get a feel for the project, then:
 
 - Discuss the project with us on [Discourse](https://universal-blue.discourse.group/).
 - [Join our Discord](https://discord.gg/WEu6BdFEtp)
   - We strive for a safe, inclusive community.
 - Pull requests encouraged and accepted.
 
-If you're building your own custom images feel free to add them to [our awesome list](https://github.com/ublue-os/awesome-custom-images)!
+If you're building your own custom images feel free to add them to [our awesome list](https://universal-blue.discourse.group/t/list-of-community-created-custom-images/340)!
diff --git a/docs/tinker/community.md b/docs/tinker/community.md
@@ -2,7 +2,7 @@
 
 Congratulations! You've now created an OS image to suit your own whims or tastes!
 
-You can share it with others on our [discussion forums](https://universal-blue.discourse.group/c/contributing/7) or [Discord server](https://discord.gg/WEu6BdFEtp). PR it into our awesome list [awesome-custom-images](https://github.com/ublue-os/awesome-custom-images).
+You can share it with others on our [discussion forums](https://universal-blue.discourse.group/c/contributing/7) or [Discord server](https://discord.gg/WEu6BdFEtp). PR it into our awesome list [awesome-custom-images](https://universal-blue.discourse.group/t/list-of-community-created-custom-images/340).
 
 Encountered an issue? Something lacking in the documentation? Check out the issue tracker [for startingpoint](https://github.com/ublue-os/startingpoint/issues) and [for this website](https://github.com/ublue-os/website/issues), or ask for help from our community.