From 9076063d13ae4545ee8501404012a450850070bf Mon Sep 17 00:00:00 2001 From: Shanary <86130442+ShanaryS@users.noreply.github.com> Date: Mon, 7 Oct 2024 02:26:51 -0400 Subject: [PATCH] update(v6-migration): add step by step guide (#56) Step by step guide --- docs/reference/utils.md | 6 +++++- docs/v6-migration.md | 12 ++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/reference/utils.md b/docs/reference/utils.md index 1e20631..8679eac 100644 --- a/docs/reference/utils.md +++ b/docs/reference/utils.md @@ -20,7 +20,11 @@ cross-seed gen-config -d ### `cross-seed clear-cache` -Clear the cache of previous decisions that are never rechecked, usually unnecessary. +:::danger +Do not use unless instructed to, this rarely necessary. Seek support if you believe it's necessary. +::: + +Clear the cache without causing torrents to be re-snatched and reset the timestamps for [`excludeOlder`](../basics/options.md#excludeolder) and [`excludeRecentSearch`](../basics/options.md#excluderecentsearch). ### `cross-seed test-notification` diff --git a/docs/v6-migration.md b/docs/v6-migration.md index 1fd3bd5..2bc018e 100644 --- a/docs/v6-migration.md +++ b/docs/v6-migration.md @@ -396,6 +396,18 @@ Here is a short list of other changes made in v6. These are some of the behind-t ## Extra +### Step-by-Step Guide + +:::danger +Do **_NOT_** skip straight to this section. All the information covered on this page is important and can potentially cause disastrous consequences if ignored. +::: + +- Update your config to modify, add, and remove the options covered in the [breaking changes section](#breaking-changes-tldr). +- Ensure you've read through this page and have updated your options to take advantage of the new capabilities and modified behavior. +- Set [rssCadence](./basics/options.md#rsscadence) and [searchCadence](./basics/options.md#searchcadence) to `null`. Start `cross-seed` and correct any configuration errors that `cross-seed` displays. +- Once `cross-seed` is running, check the verbose logs to ensure autobrr announces are not failing. +- Finally, set your desired `rssCadence` and `searchCadence` and restart `cross-seed`. + ### [`flatLinking`](./basics/options.md#flatlinking) Migration :::caution