From cb25d949ebd6fa32a1118568341c6f494dabb0ad Mon Sep 17 00:00:00 2001 From: Nick Gerace Date: Wed, 16 Aug 2023 12:56:19 -0400 Subject: [PATCH] docs: add about section and rancher desktop notes - Add about section to README - Add rancher desktop notes to development environment doc - Remove note about alphabetical requirement for contributors list Signed-off-by: Nick Gerace --- CONTRIBUTING.md | 3 +-- README.md | 5 +++++ docs/DEVELOPMENT_ENVIRONMENT.md | 7 +++++++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b732f8f402..323d0e19bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,8 +107,7 @@ Above all, ensure that the format described at the beginning is preserved. When making changes, ensure the following: -- Alphabetical ordering is retained - - Ordering is based on the beginning of the line and is case-insensitive +- Your individual line was appended to the bottom of the list - No additional newlines were added - Your individual line has no trailing or leading spaces - Your individual line matches the aforementioned format diff --git a/README.md b/README.md index b2b91407ee..899febcca7 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ This is a monolithic repository containing the System Initiative software. +## About + +System Initiative is a collaborative power tool designed to remove the papercuts from DevOps work. +To learn more, read our ["Second Wave DevOps" blog post](https://www.systeminit.com/blog-second-wave-devops). + ## Quickstart If you would like to get System Initiative (SI) up and running, navigate to the installation page on [our website](https://systeminit.com) to get started. diff --git a/docs/DEVELOPMENT_ENVIRONMENT.md b/docs/DEVELOPMENT_ENVIRONMENT.md index f0de14465b..1e3f2e28c0 100644 --- a/docs/DEVELOPMENT_ENVIRONMENT.md +++ b/docs/DEVELOPMENT_ENVIRONMENT.md @@ -91,6 +91,13 @@ For Docker Desktop, the version corresponding to your native architecture should WSL2 users should be able to use either Docker Desktop for WSL2 or Docker Engine (i.e. installing and using `docker` within the distro and not interacting with the host). +#### Rancher Desktop + +Since [Rancher Desktop](https://rancherdesktop.io/) provides the ability to use the [moby](https://github.com/moby/moby), +you can use it to run and develop the System Initiative software. +However, it is untested, and you may need to further configuration depending on your platform. +For example, on WSL2 via Windows, you may need to configure credentials in `~/.local/share`. + ### (Optional) Direnv [Direnv](https://direnv.net/) (version >= 2.30) with [nix-direnv](https://github.com/nix-community/nix-direnv) can