From 4f1ea10571e1d8f7769adba21f8c248568034805 Mon Sep 17 00:00:00 2001 From: Flying Sausages Date: Fri, 28 May 2021 10:29:10 +0200 Subject: [PATCH 1/5] develop brnahc docs --- docs/dev/{beta-testing.md => pre-release.md} | 25 +++++++++++++++----- docs/guides/customisations.md | 4 ++-- 2 files changed, 21 insertions(+), 8 deletions(-) rename docs/dev/{beta-testing.md => pre-release.md} (78%) diff --git a/docs/dev/beta-testing.md b/docs/dev/pre-release.md similarity index 78% rename from docs/dev/beta-testing.md rename to docs/dev/pre-release.md index 1156f10e..3eae462c 100644 --- a/docs/dev/beta-testing.md +++ b/docs/dev/pre-release.md @@ -1,19 +1,32 @@ --- -id: beta-testing +id: pre-release title: So you want to run some pre-release software? -sidebar_label: Beta testing +sidebar_label: Pre-release --- We often need the community's help to test new applications. As the whole tool set is tracked in git, you can try new features quite easily. -:::warning Watch the fuck out! -Please make sure you only do this if you know what you're doing. A poorly written installer could easily destroy your entire machine beyond any hope of repair. If you do not know how you would get out of a completely broken install, do not attempt these steps! -::: - Anyway, if you're courageous enough, here's how you can test the latest and coolest stuff! +## Using the `develop` branch + +We have two update rings. `master` (the default branch) is extremely closely monitored for stability, and our `develop` branch is used to put new bleeding edge features out in the open. + +You can seemlessly transition between `develop` and `master` at any point by running the commands below. + +```bash +sudo box switchbranch develop +``` + +Please note that going from `develop` to `master` will _not_ remove any changes that were applied while on `develop`. While we believe you should have no issue going in this direction, we cannot guarantee it 100%. Check with us in the discord if you face any issues when doing this. + + ## The branch checkout dance +:::warning Watch the fuck out! +Please make sure you only do this if you know what you're doing. A poorly written installer could easily destroy your entire machine beyond any hope of repair. If you do not know how you would get out of a completely broken install, do not attempt these steps! +::: + There are two types branches you might want to test. One that is made by the swizzin team, and one that is made on a repository forked from swizzin. As soon as you're on the branch you need to be on, you just keep using `box` just like you usually would. Just watch out for `box update`s! read more about those [below](#preventing-updates). diff --git a/docs/guides/customisations.md b/docs/guides/customisations.md index bf628834..25ee42aa 100644 --- a/docs/guides/customisations.md +++ b/docs/guides/customisations.md @@ -14,8 +14,8 @@ Below is a list of cusomtisations, scripts and repos that you can use to get som Make sure to not update your swizzin from the git repo afterwards, as that could break your install. Please see the [section on updating](/dev/setup#updating-mechanism) in the dev documentation. ::: -:::success Check out our beta features too! -Our release cycle is a little slow due to a low amount of testers, so if you want to help out and provide feedback for us and get to use new apps and features before everyone else, please check out the [Beta testing docs](dev/beta-testing) +:::success Check out our pre-release features too! +We have a "fast" ring and a "slow" ring for our updates. Feel free to check out how to get the latest apps using our [Pre-release docs](dev/pre-release) :::