diff --git a/docs/administration.md b/docs/administration.md index 7e5ca2d41..511015b6b 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -62,6 +62,10 @@ copies you created in the steps above. ## Updating Paperless {#updating} +!!! warning + + Please review the [migration instructions](migration-v3.md) before upgrading Paperless-ngx to v3.0, it includes some breaking changes that require manual intervention before upgrading. + ### Docker Route {#docker-updating} If a new release of paperless-ngx is available, upgrading depends on how diff --git a/docs/migration.md b/docs/migration-v3.md similarity index 99% rename from docs/migration.md rename to docs/migration-v3.md index 0e9920b60..91d9ed54d 100644 --- a/docs/migration.md +++ b/docs/migration-v3.md @@ -74,7 +74,7 @@ See [`PAPERLESS_DBENGINE`](configuration.md#PAPERLESS_DBENGINE) for accepted val ## Database Advanced Options -The individual SSL, timeout, and pooling variables have been removed in favour of a +The individual SSL, timeout, and pooling variables have been removed in favor of a single [`PAPERLESS_DB_OPTIONS`](configuration.md#PAPERLESS_DB_OPTIONS) string. This consolidates a growing set of engine-specific variables into one place, and allows any option supported by the underlying database driver to be set without requiring a diff --git a/zensical.toml b/zensical.toml index 584707aec..d78ed4b39 100644 --- a/zensical.toml +++ b/zensical.toml @@ -16,10 +16,12 @@ repo_name = "paperless-ngx/paperless-ngx" nav = [ "index.md", "setup.md", - "migration.md", "usage.md", "configuration.md", - "administration.md", + { Administration = [ + "administration.md", + { "v3 Migration Guide" = "migration-v3.md" }, + ] }, "advanced_usage.md", "api.md", "development.md",