diff --git a/contributing/sigs-and-committees.md b/community.md similarity index 88% rename from contributing/sigs-and-committees.md rename to community.md index 3e7e426..6b66540 100644 --- a/contributing/sigs-and-committees.md +++ b/community.md @@ -12,13 +12,13 @@ dateCreated: 2024-05-05T16:35:17.642Z SIGs, or "Special Interest Groups" are groups of people who focus on a particular area. They have specific projects and tasks with clear "things" as outcomes. For example, the Core Special Interest Group maintains vital packages and is involved in creating templates for new systems, and the Documentation Special Interest Group maintains the Wiki. -For more information on SIGs, what SIGs exist, and how to join one, please see [our full page on SIGs](/contributing/sigs-and-committees/sigs). +For more information on SIGs, what SIGs exist, and how to join one, please see [our full page on SIGs](/community/sigs). ## What's a committee? Committees handle the direction of the project in a particular area. For example, the Security Committee handles security in the whole project, setting guidelines for how SIGs should handle security. -For more information on committees, what committees exist, and how to join one, please see [our full page on committees](/contributing/sigs-and-committees/committees). +For more information on committees, what committees exist, and how to join one, please see [our full page on committees](/community/committees). ## What's the difference? diff --git a/contributing/sigs-and-committees/committees.md b/community/committees.md similarity index 100% rename from contributing/sigs-and-committees/committees.md rename to community/committees.md diff --git a/contributing/sigs-and-committees/security/aux-security-team.md b/community/security/aux-security-team.md similarity index 100% rename from contributing/sigs-and-committees/security/aux-security-team.md rename to community/security/aux-security-team.md diff --git a/contributing/sigs-and-committees/security/onboarding.md b/community/security/onboarding.md similarity index 93% rename from contributing/sigs-and-committees/security/onboarding.md rename to community/security/onboarding.md index e40bcc6..15bb7bb 100644 --- a/contributing/sigs-and-committees/security/onboarding.md +++ b/community/security/onboarding.md @@ -20,7 +20,7 @@ Should any of the links below be broken or descriptions inaccurate we highly app 3) Add/ update your membership status in the [community repo])(https://github.com/auxolotl/community) - Add or update your user settings in [`users.nix`](https://github.com/auxolotl/community/blob/main/users.nix) - Add your user to list `committees.security.members` in [`memberships.nix`](https://github.com/auxolotl/community/blob/main/memberships.nix) - - Create a PR to add yourself to the ["Team members" in the wiki](https://github.com/auxolotl/wiki/blob/main/contributing/sigs-and-committees/security/aux-security-team.md) + - Create a PR to add yourself to the ["Team members" in the wiki](https://github.com/auxolotl/wiki/blob/main/community/security/aux-security-team.md) Make sure to stick with the alphabetic ordering for readability! @@ -30,4 +30,4 @@ Make sure you have joined the following channels on Matrix in which ad-hoc commu - [COM: Security - General](https://matrix.to/#/#COMSEC-GEN:auxolotl.org) ## Meeting notes -Meeting notes are being archived and tagged in the forum, they can be accessed by filtering for the [meeting-minutes tag](https://forum.aux.computer/tags/c/committees/security-committee/26/meeting-minutes). \ No newline at end of file +Meeting notes are being archived and tagged in the forum, they can be accessed by filtering for the [meeting-minutes tag](https://forum.aux.computer/tags/c/committees/security-committee/26/meeting-minutes). diff --git a/contributing/sigs-and-committees/security/welcome.md b/community/security/welcome.md similarity index 100% rename from contributing/sigs-and-committees/security/welcome.md rename to community/security/welcome.md diff --git a/contributing/sigs-and-committees/sigs.md b/community/sigs.md similarity index 100% rename from contributing/sigs-and-committees/sigs.md rename to community/sigs.md diff --git a/contributing/matrix.md b/contributing/matrix.md index 211579a..d5f890e 100644 --- a/contributing/matrix.md +++ b/contributing/matrix.md @@ -22,7 +22,7 @@ If you have concerns about an interaction on Matrix and want to report something | ---------------- | --------------------------------------------------------- | ------------------------------------------------------------------ | | Auxolotl General | Discuss the project, how you're using it, or ask for help | [#general:auxolotl.org](https://matrix.to/#/#general:auxolotl.org) | -We also have [SIG-and-committee](/contributing/sigs-and-committees)-specific channels. +We also have [SIG-and-committee](/community)-specific channels. ## For SIGs diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..d6c4e2d --- /dev/null +++ b/getting-started.md @@ -0,0 +1,79 @@ +--- +title: Getting Started Guide +description: A quick guide to getting started with installing and using Auxolotl. +published: false +date: 2024-05-11T20:30:05.302Z +tags: installation, tutorial +editor: markdown +dateCreated: 2024-05-05T15:44:03.224Z +--- + +> **This page is outdated** +> After the [roadmap changes](https://forum.aux.computer/t/updates-and-clarifications-to-our-roadmap/593) this page should no longer refer to `auxolotl/nixpkgs`. It would be good to have a migration guide, but it would require serious modification of this page. Do not follow the instructions on this page. It is only available to logged-in users. +{.is-danger} + +# Getting Started With Auxolotl + +There are a few ways you can get started with Aux: + +- [I want to install the full distribution.](#installing-the-aux-distribution) +- [I want to convert my existing NixOS install to Auxolotl](#converting-nixos-to-aux) +- [I just want to install the Aux package manager and command-line tool.](#installing-the-aux-command-line-tool) + +Other ways to use Aux: + +- [Flake templates](#flake-templates) + +## Installing the Aux command-line tool + +Open a terminal and run this command to install Aux: + +```shell= +$ TODO +``` + +Verify the installation by running this command: + +```shell= +$ TODO +``` + +## Converting NixOS to Aux + +If you have an existing NixOS installation and want to convert it to use Aux, all you need to do is change your `nixpkgs` source to use the Auxolotl nixpkgs repository (substituting `` with desired release - such as `unstable` or `23.11`). + +### Channels + +To change your `nixpkgs` channel to pull from Aux, run the following command: + +```shell= +nix-channel --add https://github.com/auxolotl/nixpkgs/nixos- nixpkgs +``` + +On your next `nix-channel --update` or `nixos-rebuild --upgrade`, Aux will get pulled. + +### Flakes + +Open your `flake.nix` file and change the following line: + +```nix +nixpkgs.url = "github:NixOS/nixpkgs/nixos-"; +``` + +to: + +```nix +nixpkgs.url = "github:auxolotl/nixpkgs/nixos-"; +``` + +## Installing the Aux distribution + +==TODO== + +## Other ways to use Aux + +### Flake templates + +[Download from GitHub](https://github.com/auxolotl/templates) + +Aux provides [templates](https://github.com/auxolotl/templates) for you to use to bootstrap a default Nix system with Aux. These include templates for Linux, Darwin (macOS), and home-manager. \ No newline at end of file diff --git a/install.md b/install.md deleted file mode 100644 index e3e3bec..0000000 --- a/install.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Installation Guide -description: A quick guide to getting started with installing and using Auxolotl. -published: true -date: 2024-05-16T21:38:03.976Z -tags: installation, tutorial -editor: markdown -dateCreated: 2024-05-05T15:44:03.224Z ---- - -# Getting Started With Auxolotl - -There are a few ways you can get started with Aux: - -- [I just want to install the Aux package manager and command-line tool.](#installing-the-aux-command-line-tool) - -Other ways to use Aux: - -- [Flake templates](#flake-templates) - -## Installing the Aux command-line tool - -Open a terminal and run this command to install Aux: - -```shell= -$ TODO -``` - -Verify the installation by running this command: - -```shell= -$ TODO -``` - -## Other ways to use Aux - -### Flake templates - -[Download from GitHub](https://github.com/auxolotl/templates) - -Aux provides [templates](https://github.com/auxolotl/templates) for you to use to bootstrap a default Nix system with Aux. These include templates for Linux, Darwin (macOS), and home-manager. \ No newline at end of file diff --git a/migration.md b/migration.md deleted file mode 100644 index ff7090b..0000000 --- a/migration.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Migration Guide -description: Migrating from Nix to Aux -published: true -date: 2024-05-16T21:36:30.357Z -tags: -editor: markdown -dateCreated: 2024-05-16T21:27:55.828Z ---- - -# Migration from Nix to Aux -> This page is a work in progress -{.is-warning} - -## Lix -One of the things we're transferring out of is NixCPP, our chosen replacement is our lovely friends at [Lix](https://lix.systems). Feel free to check out their [Lix installation guide](https://lix.systems/install/) on their website. \ No newline at end of file