From 404a2d1f02aed0052a5ea96d3ebc5eea06d9c81c Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 12 Apr 2022 07:37:02 -0700 Subject: [PATCH 1/3] Bump header level --- .github/release-drafter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index f5c9ebeb5..7ddeb4293 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -29,6 +29,6 @@ change-template: '- $TITLE @$AUTHOR (#$NUMBER)' change-title-escapes: '\<*_&#@' tag-prefix: "ngx-" template: | - ## Changelog + # Changelog $CHANGES From b06a4c52e3fb5cde41fa389d9bcea9aa44aa8783 Mon Sep 17 00:00:00 2001 From: Quinn Casey Date: Tue, 12 Apr 2022 07:37:49 -0700 Subject: [PATCH 2/3] Add Breaking Changes --- .github/release-drafter.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 7ddeb4293..d3e2e165f 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -1,4 +1,7 @@ categories: + - title: 'Breaking Changes' + labels: + - 'breaking-change' - title: 'Features' labels: - 'enhancement' From b8df886b3ee87e2a5899de3a6f23251366fa5237 Mon Sep 17 00:00:00 2001 From: Adrian Lumpe Date: Wed, 13 Apr 2022 15:39:49 +0200 Subject: [PATCH 3/3] corrects some spelling mistakes in docs --- docs/administration.rst | 2 +- docs/advanced_usage.rst | 2 +- docs/configuration.rst | 4 ++-- docs/faq.rst | 2 +- docs/usage_overview.rst | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/administration.rst b/docs/administration.rst index 1a9dfd548..75c5b57d0 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -369,7 +369,7 @@ the naming scheme. .. warning:: - Since this command moves you documents around alot, it is advised to to + Since this command moves you documents around a lot, it is advised to to a backup before. The renaming logic is robust and will never overwrite or delete a file, but you can't ever be careful enough. diff --git a/docs/advanced_usage.rst b/docs/advanced_usage.rst index b50107003..a04d8c3b1 100644 --- a/docs/advanced_usage.rst +++ b/docs/advanced_usage.rst @@ -242,7 +242,7 @@ will create a directory structure as follows: last filename a document was stored as. If you do rename a file, paperless will report your files as missing and won't be able to find them. -Paperless provides the following placeholders withing filenames: +Paperless provides the following placeholders within filenames: * ``{asn}``: The archive serial number of the document, or "none". * ``{correspondent}``: The name of the correspondent, or "none". diff --git a/docs/configuration.rst b/docs/configuration.rst index 90c5918c8..ae789f616 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -185,7 +185,7 @@ PAPERLESS_AUTO_LOGIN_USERNAME= PAPERLESS_ADMIN_USER= If this environment variable is specified, Paperless automatically creates a superuser with the provided username at start. This is useful in cases - where you can not run the `createsuperuser` command seperately, such as Kubernetes + where you can not run the `createsuperuser` command separately, such as Kubernetes or AWS ECS. Requires `PAPERLESS_ADMIN_PASSWORD` to be set. @@ -659,7 +659,7 @@ PAPERLESS_CONSUMER_IGNORE_PATTERNS= This can be adjusted by configuring a custom json array with patterns to exclude. - Defautls to ``[".DS_STORE/*", "._*", ".stfolder/*"]``. + Defaults to ``[".DS_STORE/*", "._*", ".stfolder/*"]``. Binaries ######## diff --git a/docs/faq.rst b/docs/faq.rst index f9c22a48c..71a9272af 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -7,7 +7,7 @@ Frequently asked questions **A:** While Paperless-ngx is already considered largely "feature-complete" it is a community-driven project and development will be guided in this way. New features can be submitted via -GitHub discussions and "up-voted" by the community but this is not a garauntee the feature +GitHub discussions and "up-voted" by the community but this is not a guarantee the feature will be implemented. This project will always be open to collaboration in the form of PRs, ideas etc. diff --git a/docs/usage_overview.rst b/docs/usage_overview.rst index c7260e1cb..ffaff8f3e 100644 --- a/docs/usage_overview.rst +++ b/docs/usage_overview.rst @@ -62,7 +62,7 @@ your documents: 1. OCR the document, if it has no text. Digital documents usually have text, and this step will be skipped for those documents. -2. Paperless will create an archiveable PDF/A document from your document. +2. Paperless will create an archivable PDF/A document from your document. If this document is coming from your scanner, it will have embedded selectable text. 3. Paperless performs automatic matching of tags, correspondents and types on the document before storing it in the database.