From 8939c3401b72eab5d339d11b11caaa103adb98a1 Mon Sep 17 00:00:00 2001 From: Timothy DeHerrera Date: Wed, 17 Feb 2021 18:31:33 -0700 Subject: [PATCH] project rename: nixflk -> devos --- README.md | 16 ++++++++-------- book.toml | 4 ++-- cachix/README.md | 2 +- cachix/nrdxp.nix | 4 ++-- doc/flk/get.md | 2 +- doc/flk/up.md | 2 +- doc/integrations/deploy.md | 2 +- doc/integrations/index.md | 2 +- doc/start/index.md | 4 ++-- extern/README.md | 2 +- hosts/README.md | 2 +- modules/README.md | 4 ++-- pkgs/README.md | 2 +- profiles/README.md | 4 ++-- secrets/README.md | 2 +- shell/flk.sh | 4 ++-- suites/README.md | 2 +- users/README.md | 4 ++-- 18 files changed, 32 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 802bbc51..8b4fd25e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -[![Build](https://img.shields.io/github/checks-status/nrdxp/nixflk/core)](https://hercules-ci.com/github/nrdxp/nixflk/jobs) -[![MIT License](https://img.shields.io/github/license/nrdxp/nixflk)][mit] +[![Build](https://img.shields.io/github/checks-status/divnix/devos/core)](https://hercules-ci.com/github/divnix/devos/jobs) +[![MIT License](https://img.shields.io/github/license/divnix/devos)][mit] [![NixOS 20.09](https://img.shields.io/badge/NixOS-v20.09-blue.svg?style=flat&logo=NixOS&logoColor=white)](https://nixos.org) > #### ⚠ Advisory ⚠ -> Nixflk leverages the [flakes][flakes] feature available via an _experimental_ +> DevOS leverages the [flakes][flakes] feature available via an _experimental_ > branch of [nix][nix]. Until nix 3.0 is released, this project should be > considered unstable, though quite usable as flakes have been maturing > _well_ -> [for a while](https://github.com/nrdxp/nixflk/tree/17713c22d07c54525c728c62060a0428b76dee3b). +> [for a while](https://github.com/divnix/devos/tree/17713c22d07c54525c728c62060a0428b76dee3b). # Introduction -Nixflk is a template which grants a simple way to use, deploy and manage +DevOS is a template which grants a simple way to use, deploy and manage [NixOS][nixos] systems for personal and productive use. It does this by providing a sane repository structure, integrating several popular projects like [home-manager][home-manager], setting clear guidelines, offering useful @@ -48,13 +48,13 @@ quite frequent. - [devshell](https://github.com/numtide/devshell) # License -Nixflk is licensed under the [MIT License][mit]. +DevOS is licensed under the [MIT License][mit]. [nix]: https://nixos.org/manual/nix/stable [mit]: https://mit-license.org [nixos]: https://nixos.org/manual/nixos/stable [home-manager]: https://nix-community.github.io/home-manager [flakes]: https://nixos.wiki/wiki/Flakes -[core]: https://github.com/nrdxp/nixflk -[community]: https://github.com/nrdxp/nixflk/tree/community +[core]: https://github.com/divnix/devos +[community]: https://github.com/divnix/devos/tree/community [dotfiles]: https://github.com/hlissner/dotfiles diff --git a/book.toml b/book.toml index e843940c..8ca5401b 100644 --- a/book.toml +++ b/book.toml @@ -3,7 +3,7 @@ authors = ["Timothy DeHerrera"] language = "en" multilingual = false src = "." -title = "nixflk docs" +title = "devos docs" [output.html] -site-url = "/nixflk/" +site-url = "/devos/" diff --git a/cachix/README.md b/cachix/README.md index de732dc7..8c1027a2 100644 --- a/cachix/README.md +++ b/cachix/README.md @@ -5,7 +5,7 @@ add your own cache, assuming the template lives in /etc/nixos, by simply running `sudo cachix use yourcache`. These caches are only added to the system after a `nixos-rebuild switch`, so it -is recommended to call `cachix use nrdxp` before the initial deployment, as it +is recommended to call `cachix use divnix` before the initial deployment, as it will save a lot of build time. In the future, users will be able to skip this step once the ability to define diff --git a/cachix/nrdxp.nix b/cachix/nrdxp.nix index bb3b4a59..a5d521b8 100644 --- a/cachix/nrdxp.nix +++ b/cachix/nrdxp.nix @@ -1,10 +1,10 @@ { nix = { binaryCaches = [ - "https://nrdxp.cachix.org" + "https://divnix.cachix.org" ]; binaryCachePublicKeys = [ - "nrdxp.cachix.org-1:Fc5PSqY2Jm1TrWfm88l6cvGWwz3s93c6IOifQWnhNW4=" + "divnix.cachix.org-1:Fc5PSqY2Jm1TrWfm88l6cvGWwz3s93c6IOifQWnhNW4=" ]; }; } diff --git a/doc/flk/get.md b/doc/flk/get.md index bd10d5f5..b1f79906 100644 --- a/doc/flk/get.md +++ b/doc/flk/get.md @@ -1,5 +1,5 @@ # get -The `get` subcommand is useful for getting a bare copy of nixflk without the +The `get` subcommand is useful for getting a bare copy of devos without the git history. You can pull either the core or community branches. ## Usage diff --git a/doc/flk/up.md b/doc/flk/up.md index 9d795fb4..265e03a0 100644 --- a/doc/flk/up.md +++ b/doc/flk/up.md @@ -1,4 +1,4 @@ # up The `up` subcommand is a simple shortcut for `nixos-generate-config` that is -compatible with nixflk. There is a short explanation in the the getting started +compatible with devos. There is a short explanation in the the getting started [guide](../start/from-nixos.md#generate-configuration). diff --git a/doc/integrations/deploy.md b/doc/integrations/deploy.md index 821afc04..3a4dde8e 100644 --- a/doc/integrations/deploy.md +++ b/doc/integrations/deploy.md @@ -1,6 +1,6 @@ # deploy-rs [Deploy-rs][d-rs] is a tool for managing NixOS remote machines. It was -chosen for nixflk after the author experienced some frustrations with the +chosen for devos after the author experienced some frustrations with the stateful nature of nixops' db. It was also designed from scratch to support flake based deployments, and so is an excellent tool for the job. diff --git a/doc/integrations/index.md b/doc/integrations/index.md index f15300c8..5ea739ec 100644 --- a/doc/integrations/index.md +++ b/doc/integrations/index.md @@ -1,5 +1,5 @@ # Integrations -This section explores some of the optional tools included with nixflk to provide +This section explores some of the optional tools included with devos to provide a solution to common concerns such as ci and remote deployment. An effort is made to choose tools that treat nix, and where possible flakes, as first class citizens. diff --git a/doc/start/index.md b/doc/start/index.md index 3af0b3d0..ddfc8571 100644 --- a/doc/start/index.md +++ b/doc/start/index.md @@ -4,9 +4,9 @@ The only dependency is nix, so make sure you have it [installed][install-nix]. ## Get the Template Here is a snippet that will get you the template without the git history: ```sh -nix-shell -p cachix --run cachix use nrdxp +nix-shell -p cachix --run cachix use divnix -nix-shell https://github.com/nrdxp/nixflk/archive/core.tar.gz -A shell \ +nix-shell https://github.com/divnix/devos/archive/core.tar.gz -A shell \ --run "flk get core" cd flk diff --git a/extern/README.md b/extern/README.md index 58f20e23..80f5c15b 100644 --- a/extern/README.md +++ b/extern/README.md @@ -7,4 +7,4 @@ used to extend the arguments passed to all NixOS modules, allowing for arbitrary values to be passed from flake inputs to the rest of your configuration. -[extern]: https://github.com/nrdxp/nixflk/tree/core/extern/default.nix +[extern]: https://github.com/divnix/devos/tree/core/extern/default.nix diff --git a/hosts/README.md b/hosts/README.md index 043f9e90..d101ec97 100644 --- a/hosts/README.md +++ b/hosts/README.md @@ -2,7 +2,7 @@ Nix flakes contain an output called `nixosConfigurations` declaring an attribute set of valid NixOS systems. To simplify the management and creation -of these hosts, nixflk automatically imports every _.nix_ file inside this +of these hosts, devos automatically imports every _.nix_ file inside this directory to the mentioned attribute set, applying the projects defaults to each. The only hard requirement is that the file contain a valid NixOS module. diff --git a/modules/README.md b/modules/README.md index 5da01cc9..1f3d9d98 100644 --- a/modules/README.md +++ b/modules/README.md @@ -61,12 +61,12 @@ flake.nix: { # inputs omitted - outputs = { self, nixflk, nixpkgs, ... }: { + outputs = { self, devos, nixpkgs, ... }: { nixosConfigurations.myConfig = nixpkgs.lib.nixosSystem { system = "..."; modules = [ - nixflk.nixosModules.my-service + devos.nixosModules.my-service ({ ... }: { services.MyService.enable = true; }) diff --git a/pkgs/README.md b/pkgs/README.md index e84c236f..dd9352fb 100644 --- a/pkgs/README.md +++ b/pkgs/README.md @@ -41,7 +41,7 @@ stdenv.mkDerivation { meta = with stdenv.lib; { description = "Simple .INI file parser in C"; homepage = "https://github.com/benhoyt/inih"; - maintainers = [ maintainers.nrdxp ]; + maintainers = [ maintainers.divnix ]; license = licenses.bsd3; platforms = platforms.all; inherit version; diff --git a/profiles/README.md b/profiles/README.md index d9c4f9f1..1e17c2a1 100644 --- a/profiles/README.md +++ b/profiles/README.md @@ -2,7 +2,7 @@ Profiles are simply NixOS modules which contain generic expressions suitable for any host. A good example is the configuration for a text editor, or window manager. If you need some concrete examples, just checkout the -community [branch](https://github.com/nrdxp/nixflk/tree/community/profiles). +community [branch](https://github.com/divnix/devos/tree/community/profiles). ## Constraints For the sake of consistency, there are a few minor constraints. First of all, a @@ -41,7 +41,7 @@ you can either pull in the whole development profile, or pick and choose individual programs. ## Conclusion -Profiles are the most important concept in nixflk. They allow us to keep our +Profiles are the most important concept in devos. They allow us to keep our nix expressions self contained and modular. This way we can maximize reuse while minimizing boilerplate. Always strive to keep your profiles as generic and modular as possible. Anything machine specific belongs in your diff --git a/secrets/README.md b/secrets/README.md index 107b49f1..de77c5b8 100644 --- a/secrets/README.md +++ b/secrets/README.md @@ -11,7 +11,7 @@ be sure to run `git-crypt init` before putting anything in here. > within the nix/store so, if they end up in the nix/store after deployment, they > will be world readable on that machine. > -> The author of nixflk intends to implement a workaround for this situation in +> The author of devos intends to implement a workaround for this situation in > the near future, but for the time being, simple be aware of this. [git-crypt]: https://github.com/AGWA/git-crypt diff --git a/shell/flk.sh b/shell/flk.sh index 81b805d1..327f9819 100755 --- a/shell/flk.sh +++ b/shell/flk.sh @@ -1,6 +1,6 @@ [[ -d "$DEVSHELL_ROOT" ]] || { - echo "This script must be run from nixflk's devshell" >&2 + echo "This script must be run from devos's devshell" >&2 exit 1 } @@ -52,7 +52,7 @@ case "$1" in "get") if [[ "$2" == "core" || "$2" == "community" ]]; then - nix flake new -t "github:nrdxp/nixflk/$2" "${3:-flk}" + nix flake new -t "github:divnix/devos/$2" "${3:-flk}" else echo "flk get [core|community] {dest}" exit 1 diff --git a/suites/README.md b/suites/README.md index e8f74890..68bb8685 100644 --- a/suites/README.md +++ b/suites/README.md @@ -1,7 +1,7 @@ # Suites Suites provide a mechanism for users to easily combine and name collecitons of profiles. For good examples, check out the suites defined in the community -[branch](https://github.com/nrdxp/nixflk/blob/community/suites/default.nix). +[branch](https://github.com/divnix/devos/blob/community/suites/default.nix). In the future, we will use suites as a mechanism for deploying various machine types which don't depend on hardware, such as vm's and containers. diff --git a/users/README.md b/users/README.md index 4963fdfd..c36aa3ac 100644 --- a/users/README.md +++ b/users/README.md @@ -4,7 +4,7 @@ Users are a special case of [profiles](../profiles) that define system users and [home-manager][home-manager] configurations. For your convenience, home manager is wired in by default so all you have to worry about is declaring your users. For a fully fleshed out example, check out the developers personal -[branch](https://github.com/nrdxp/nixflk/tree/nrd/users/nrd/default.nix). +[branch](https://github.com/divnix/devos/tree/nrd/users/nrd/default.nix). ## Basic Usage `users/myuser/default.nix`: @@ -42,7 +42,7 @@ flk home NixOS nixos switch ### Manually from outside the project: ```sh # build -nix build "github:nrdxp/nixflk#hmActivationPackages.NixOS.nixos" +nix build "github:divnix/devos#hmActivationPackages.NixOS.nixos" # activate ./result/activate && unlink result