From 5366cffee7f7954dc354192b3b3903e754355848 Mon Sep 17 00:00:00 2001 From: zowoq <59103226+zowoq@users.noreply.github.com> Date: Sun, 8 Jan 2023 23:55:12 +1000 Subject: [PATCH] docs/README.md: reorganise (#367) * README.md: administrators -> nix-community administrators * docs/README.md: reorganise --- README.md | 2 +- docs/README.md | 34 ++++++++++++---------------------- 2 files changed, 13 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 24b803b..83800dd 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ As PRs from forks don't have automatic CI checks, admins can test PRs by posting * `bors merge` - same as `bors try` but will also merge the PR if it builds successfully. * https://bors.tech/documentation/ -### Administrators +### nix-community administrators * @adisbladis * @flokli diff --git a/docs/README.md b/docs/README.md index 3ae6b2d..80d9d44 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,10 @@ <img src="nix-community-logo.svg" width="100" height="100" alt="Nix community"> -The @nix-community is a GitHub organization that works alongside the @NixOS organization. -The mission critical projects are hosted in the @NixOS organization. This is our playground. Maximal freedom! +@nix-community is a GitHub organization that works alongside the @NixOS organization. -If you want to do something and it doesn't interfer with other people's -project then we are here to support you. +The @NixOS organization holds all the mission-critical projects such as Nix, Nixpkgs, NixOps, Hydra, etc. + +The @nix-community organization is the community playground. We don't need to be as strict with permissions. The org can host any projects that benefit from a shared ownership. We provide infrastructure and support for those projects as well as visibility. ## Infrastructure @@ -12,25 +12,13 @@ To support our activities we have a little bit of infrastructure in place. See https://github.com/nix-community/infra for the list of services and configuration. -### Binary cache - -All the build results are being pushed to https://nix-community.cachix.org/ - -See https://app.cachix.org/cache/nix-community for the installation instructions. - ## FAQ -### What role does the @nix-community org play in the Nix ecosystem? - -The @NixOS organization holds all the mission-critical projects such as Nix, Nixpkgs, NixOps, Hydra, etc. - -The @nix-community is the community playground. We don't need to be as strict with permissions. The org can host any projects that benefit from a shared ownership. We provide infrastructure and support for those projects as well as visibility. - ### How do I get my project included? Ideally the type of projects that are accepted have some level of maturity and can benefit from a shared ownership. The goal is to have as much projects maintained and not for the org to become a graveyard. -We don't have a strict procedure. For now, ping one of the [org owners](#org-owners). +We don't have a strict procedure. For now, ping one of the [nix-community administrators](#nix-community-administrators). ### What are the rules of engagement? @@ -43,16 +31,18 @@ The Nix community is nice. Be nice! Typically this means: Nothing is set in stone. Think of these as the guidelines for our interactions. -The maintainer of a project gets admin access to the project they maintain. The maintainer is allowed to invite more people into the org and into their team. +The maintainer of a project gets admin access to the project they maintain. The maintainer can request that more people be invited into the org so they can join their projects team. -If you see a project that is under-maintained, submit PRs to fix it as if it was your own project. If the PRs don't get merged, ping the [org owners](#org-owners) +If you see a project that is under-maintained, submit PRs to fix it as if it was your own project. If the PRs don't get merged, ping the [nix-community administrators](#nix-community-administrators). -### Org owners +## nix-community administrators -If you need to contact the org owners, see [the list of org owners](https://github.com/orgs/nix-community/people?utf8=%E2%9C%93&query=+role%3Aowner). +If you need to contact the nix-community admins, they are listed [here](https://github.com/nix-community/infra#nix-community-administrators). Come chat with us in [#nix-community](https://matrix.to/#/#nix-community:nixos.org) using the matrix protocol! ## Sponsors -<img src="https://raw.githubusercontent.com/cachix/cachix/master/logo.png" width="200" alt="Cachix"> provides us with a free 1TB binary cache! +<img src="https://raw.githubusercontent.com/cachix/docs.cachix.org/master/source/logo.png" width="200" alt="Cachix"> + +[Cachix](https://www.cachix.org/) provides us with a free 1TB binary cache!