From aabac7ce371aa8ebaacd6333dce8a261fc49243f Mon Sep 17 00:00:00 2001 From: Mike Perham Date: Wed, 26 Jan 2022 09:21:52 -0800 Subject: [PATCH] Move old upgrade notes into docs/ --- Changes.md | 8 ++++---- Ent-Changes.md | 3 +-- Pro-Changes.md | 8 ++++---- 3.0-Upgrade.md => docs/3.0-Upgrade.md | 0 4.0-Upgrade.md => docs/4.0-Upgrade.md | 0 5.0-Upgrade.md => docs/5.0-Upgrade.md | 0 6.0-Upgrade.md => docs/6.0-Upgrade.md | 0 Ent-2.0-Upgrade.md => docs/Ent-2.0-Upgrade.md | 0 Pro-2.0-Upgrade.md => docs/Pro-2.0-Upgrade.md | 0 Pro-3.0-Upgrade.md => docs/Pro-3.0-Upgrade.md | 0 Pro-4.0-Upgrade.md => docs/Pro-4.0-Upgrade.md | 0 Pro-5.0-Upgrade.md => docs/Pro-5.0-Upgrade.md | 0 12 files changed, 9 insertions(+), 10 deletions(-) rename 3.0-Upgrade.md => docs/3.0-Upgrade.md (100%) rename 4.0-Upgrade.md => docs/4.0-Upgrade.md (100%) rename 5.0-Upgrade.md => docs/5.0-Upgrade.md (100%) rename 6.0-Upgrade.md => docs/6.0-Upgrade.md (100%) rename Ent-2.0-Upgrade.md => docs/Ent-2.0-Upgrade.md (100%) rename Pro-2.0-Upgrade.md => docs/Pro-2.0-Upgrade.md (100%) rename Pro-3.0-Upgrade.md => docs/Pro-3.0-Upgrade.md (100%) rename Pro-4.0-Upgrade.md => docs/Pro-4.0-Upgrade.md (100%) rename Pro-5.0-Upgrade.md => docs/Pro-5.0-Upgrade.md (100%) diff --git a/Changes.md b/Changes.md index 743a15b9..0bfb9600 100644 --- a/Changes.md +++ b/Changes.md @@ -523,7 +523,7 @@ Sidekiq::Middleware::Server::Logging -> Sidekiq::JobLogger - The `SomeWorker.set(options)` API was re-written to avoid thread-local state. [#2152] - Sidekiq Enterprise's encrypted jobs now display "[encrypted data]" in the Web UI instead of random hex bytes. -- Please see the [5.0 Upgrade notes](5.0-Upgrade.md) for more detail. +- Please see the [5.0 Upgrade notes](docs/5.0-Upgrade.md) for more detail. 4.2.10 ----------- @@ -741,7 +741,7 @@ Sidekiq::Queues.clear_all - Sidekiq's internals have been completely overhauled for performance and to remove dependencies. This has resulted in major speedups, as [detailed on my blog](http://www.mikeperham.com/2015/10/14/optimizing-sidekiq/). -- See the [4.0 upgrade notes](4.0-Upgrade.md) for more detail. +- See the [4.0 upgrade notes](docs/4.0-Upgrade.md) for more detail. 3.5.4 ----------- @@ -1008,7 +1008,7 @@ sidekiq_options :dead => false, :retry => 5 3.0.0 ----------- -Please see [3.0-Upgrade.md](3.0-Upgrade.md) for more comprehensive upgrade notes. +Please see [3.0-Upgrade.md](docs/3.0-Upgrade.md) for more comprehensive upgrade notes. - **Dead Job Queue** - jobs which run out of retries are now moved to a dead job queue. These jobs must be retried manually or they will expire @@ -1052,7 +1052,7 @@ Sidekiq::Client.via(ConnectionPool.new { Redis.new }) do end ``` **Sharding support does require a breaking change to client-side -middleware, see 3.0-Upgrade.md.** +middleware, see docs/3.0-Upgrade.md.** - New Chinese, Greek, Swedish and Czech translations for the Web UI. - Updated most languages translations for the new UI features. - **Remove official Capistrano integration** - this integration has been diff --git a/Ent-Changes.md b/Ent-Changes.md index 17aafce9..41a74671 100644 --- a/Ent-Changes.md +++ b/Ent-Changes.md @@ -92,8 +92,7 @@ sidekiq.latency.#{name} -> sidekiq.queue.latency with tag queue:#{name} 2.0.0 ------------- -- Except for the [newly required credentials](https://github.com/mperham/sidekiq/issues/4232), Sidekiq Enterprise 2.0 does - not have any significant migration steps. +- Except for the [newly required credentials](https://github.com/mperham/sidekiq/issues/4232), Sidekiq Enterprise 2.0 does not have any significant migration steps. - Sidekiq Enterprise must now be started with valid license credentials. [#4232] - Call `GC.compact` if possible in sidekiqswarm before forking [#4181] - Changes for forward-compatibility with Sidekiq 6.0. diff --git a/Pro-Changes.md b/Pro-Changes.md index 49177a31..9dc3915a 100644 --- a/Pro-Changes.md +++ b/Pro-Changes.md @@ -111,7 +111,7 @@ job.WorkerName.failure -> job.failure with tag worker:WorkerName - There is no significant migration from Sidekiq Pro 4.0 to 5.0 but make sure you read the [update notes for Sidekiq -6.0](https://github.com/mperham/sidekiq/blob/master/6.0-Upgrade.md). +6.0](https://github.com/mperham/sidekiq/blob/master/docs/6.0-Upgrade.md). - Removed various deprecated APIs and associated warnings. - **BREAKING CHANGE** Remove the `Sidekiq::Batch::Status#dead_jobs` API in favor of `Sidekiq::Batch::Status#dead_jids`. [#4217] @@ -161,7 +161,7 @@ batch.on(:death, ...) 4.0.0 --------- -- See the [Sidekiq Pro 4.0](Pro-4.0-Upgrade.md) release notes. +- See the [Sidekiq Pro 4.0](docs/Pro-4.0-Upgrade.md) release notes. 3.7.1 @@ -406,7 +406,7 @@ end 3.0.0 ----------- -- See the [Pro 3.0 release notes](Pro-3.0-Upgrade.md). +- See the [Pro 3.0 release notes](docs/Pro-3.0-Upgrade.md). 2.1.3 ----------- @@ -500,7 +500,7 @@ mount Sidekiq::Pro::Web.with(redis_pool: POOL2), at: '/sidekiq2', as: 'sidekiq2' 2.0.0 ----------- -- See [the Upgrade Notes](Pro-2.0-Upgrade.md) for detailed notes. +- See [the Upgrade Notes](docs/Pro-2.0-Upgrade.md) for detailed notes. 1.9.2 ----------- diff --git a/3.0-Upgrade.md b/docs/3.0-Upgrade.md similarity index 100% rename from 3.0-Upgrade.md rename to docs/3.0-Upgrade.md diff --git a/4.0-Upgrade.md b/docs/4.0-Upgrade.md similarity index 100% rename from 4.0-Upgrade.md rename to docs/4.0-Upgrade.md diff --git a/5.0-Upgrade.md b/docs/5.0-Upgrade.md similarity index 100% rename from 5.0-Upgrade.md rename to docs/5.0-Upgrade.md diff --git a/6.0-Upgrade.md b/docs/6.0-Upgrade.md similarity index 100% rename from 6.0-Upgrade.md rename to docs/6.0-Upgrade.md diff --git a/Ent-2.0-Upgrade.md b/docs/Ent-2.0-Upgrade.md similarity index 100% rename from Ent-2.0-Upgrade.md rename to docs/Ent-2.0-Upgrade.md diff --git a/Pro-2.0-Upgrade.md b/docs/Pro-2.0-Upgrade.md similarity index 100% rename from Pro-2.0-Upgrade.md rename to docs/Pro-2.0-Upgrade.md diff --git a/Pro-3.0-Upgrade.md b/docs/Pro-3.0-Upgrade.md similarity index 100% rename from Pro-3.0-Upgrade.md rename to docs/Pro-3.0-Upgrade.md diff --git a/Pro-4.0-Upgrade.md b/docs/Pro-4.0-Upgrade.md similarity index 100% rename from Pro-4.0-Upgrade.md rename to docs/Pro-4.0-Upgrade.md diff --git a/Pro-5.0-Upgrade.md b/docs/Pro-5.0-Upgrade.md similarity index 100% rename from Pro-5.0-Upgrade.md rename to docs/Pro-5.0-Upgrade.md