From 143fa9fdd29af54a832a24479477bd4c57547ba7 Mon Sep 17 00:00:00 2001 From: SirBerg Date: Mon, 2 Jun 2025 21:36:17 +0200 Subject: [PATCH] Fix typos --- docs/Components/Iglu Controller.md | 2 +- docs/Getting started/Install with Docker compose.md | 2 +- docs/intro.md | 11 +++++------ 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/Components/Iglu Controller.md b/docs/Components/Iglu Controller.md index d4209402..8108fc4b 100644 --- a/docs/Components/Iglu Controller.md +++ b/docs/Components/Iglu Controller.md @@ -1,4 +1,4 @@ [![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/iglu-sh/controller) ## Introduction -The **Iglu Controller** is the heart of the Iglu Project. It is a GUI to create, modify and delete [Iglu Caches](/docs/Components/Iglu%20Cache). In addition you can configure build jobs to automatically spin up [Iglu Builders](/docs/Components/Iglu%20Builder) and build [nix derivations](https://nix.dev/manual/nix/2.25/language/derivations). Those derivations will be pushed to a [cachix](https://www.cachix.org/) client compatible cache, like our [Iglu Cache](/docs/Components/Iglu%20Cache). +The **Iglu Controller** is the heart of the Iglu Project. It is a GUI to create, modify and delete [Iglu Caches](/docs/Components/Iglu%20Cache). In addition, you can configure build jobs to automatically spin up [Iglu Builders](/docs/Components/Iglu%20Builder) and build [nix derivations](https://nix.dev/manual/nix/2.25/language/derivations). Those derivations will be pushed to a [cachix](https://www.cachix.org/) client compatible cache, like our [Iglu Cache](/docs/Components/Iglu%20Cache). diff --git a/docs/Getting started/Install with Docker compose.md b/docs/Getting started/Install with Docker compose.md index 68141b0d..7e9a15df 100644 --- a/docs/Getting started/Install with Docker compose.md +++ b/docs/Getting started/Install with Docker compose.md @@ -2,7 +2,7 @@ sidebar_position: 2 --- -We recomend the installation via docker compose, as it is the simplest one. +We recommend the installation via docker compose, as it is the simplest one. ## Compose file diff --git a/docs/intro.md b/docs/intro.md index 2c3ebbbe..ce750d03 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -4,25 +4,24 @@ sidebar_position: 1 # Introducing Iglu ## What is Iglu? -**Iglu** is an easy to use cache for nix derivations. So that you don't have to build your derivations (packages, configurations, ...) multipletimes. +**Iglu** is an easy-to-use cache for nix derivations and binaries. It allows you to avoid rebuilding your derivations (packages, configurations, etc.) multiple times. You can use the official [cachix](https://hackage.haskell.org/package/cachix) client to push derivations to your own Iglu cache. ## Why Iglu? -Iglu was build to improve the usability of nix caches for normal users and organisations. We tested much caches, like +Iglu was build to improve the usability of nix caches for normal users and organisations. We tested several existing solutions, but they didn't fit our requirements. Here are some of the existing solutions we tested: - [attic](https://github.com/zhaofengli/attic/) - [cachix](https://www.cachix.org/) - [cache-server](https://github.com/mifka01/cache-server) - [nix-serve](https://github.com/edolstra/nix-serve) -Sadly, all of these didn't fit our requirements for a stable, multi-tenant implemenation that could be used with the cachix client. So we ([SirBerg](https://github.com/SirBerg) and [Svenum](https://github.com/Svenum)) decided to build our own cache! We want to provide these features: - A simple UI to manage all caches -- A stable and userfriendly experience -- A way to build and upload derivations easyliy and automated by a builtin [builder](https://github.com/iglu-sh/builder) -- An easy-to-use and easy-to-maintain codebase for either forking or colaboration +- A stable and user-friendly experience +- A way to build and upload derivations easily and automated by a builtin [builder](https://github.com/iglu-sh/builder) +- An easy-to-use and easy-to-maintain codebase for either forking or collaboration ## Comparison Here are some comparison to other caches: