From a3aa9ca2dc54e14843fbdad0c8ba994943a05600 Mon Sep 17 00:00:00 2001 From: Jonas Winkler Date: Fri, 13 Nov 2020 21:06:05 +0100 Subject: [PATCH] more docs --- docs/administration.rst | 3 ++- docs/api.rst | 8 +++++--- docs/contributing.rst | 4 ++++ docs/extending.rst | 4 ++++ docs/troubleshooting.rst | 3 +++ docs/usage_overview.rst | 25 ++++++++++++++++--------- 6 files changed, 34 insertions(+), 13 deletions(-) diff --git a/docs/administration.rst b/docs/administration.rst index 44b4d2ade..36e577443 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -9,7 +9,7 @@ Making backups .. warning:: - This section is not updated yet. + This section is not updated to paperless-ng yet. So you're bored of this whole project, or you want to make a remote backup of your files for whatever reason. This is easy to do, simply use the @@ -22,6 +22,7 @@ into an arbitrary directory. Restoring ========= + .. _administration-updating: Updating paperless diff --git a/docs/api.rst b/docs/api.rst index 41dd4dac8..8e023ade3 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -5,7 +5,7 @@ The REST API .. warning:: - This section is not updated yet. + This section is not updated to paperless-ng yet. Paperless makes use of the `Django REST Framework`_ standard API interface because of its inherent awesomeness. Conveniently, the system is also @@ -16,8 +16,10 @@ installation. .. _Django REST Framework: http://django-rest-framework.org/ -Uploading -========= +.. _api-file_uploads: + +POSTing Documents +================= File uploads in an API are hard and so far as I've been able to tell, there's no standard way of accepting them, so rather than crowbar file uploads into the diff --git a/docs/contributing.rst b/docs/contributing.rst index 9b18861a8..540081b7e 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -3,6 +3,10 @@ Contributing to Paperless ######################### +.. warning:: + + This section is not updated to paperless-ng yet. + Maybe you've been using Paperless for a while and want to add a feature or two, or maybe you've come across a bug that you have some ideas how to solve. The beauty of Free software is that you can see what's wrong and help to get it diff --git a/docs/extending.rst b/docs/extending.rst index 2afc6367b..74c44fd7d 100644 --- a/docs/extending.rst +++ b/docs/extending.rst @@ -3,6 +3,10 @@ Extending Paperless =================== +.. warning:: + + This section is not updated to paperless-ng yet. + For the most part, Paperless is monolithic, so extending it is often best managed by way of modifying the code directly and issuing a pull request on `GitHub`_. However, over time the project has been evolving to be a little diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 8ad388210..fc652689e 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -2,6 +2,9 @@ Troubleshooting *************** +.. warning:: + + This section is not updated to paperless-ng yet. Consumer warns ``OCR for XX failed`` #################################### diff --git a/docs/usage_overview.rst b/docs/usage_overview.rst index d544f98fb..344d1a1a5 100644 --- a/docs/usage_overview.rst +++ b/docs/usage_overview.rst @@ -94,15 +94,22 @@ pull emails down from an arbitrary account and dump them into the consumption directory where the consumer will follow the usual pattern on consuming the document. -Some things you need to know about this feature: +.. hint:: -* It's disabled by default. By setting the values below it will be enabled. -* It's been tested in a limited environment, so it may not work for you (please - submit a pull request if you can!) -* It's designed to **delete mail from the server once consumed**. So don't go - pointing this to your personal email account and wonder where all your stuff - went. -* Currently, only one photo (attachment) per email will work. + It's disabled by default. By setting the values below it will be enabled. + + It's been tested in a limited environment, so it may not work for you (please + submit a pull request if you can!) + +.. danger:: + + It's designed to **delete mail from the server once consumed**. So don't go + pointing this to your personal email account and wonder where all your stuff + went. + +.. hint:: + + Currently, only one photo (attachment) per email will work. So, with all that in mind, here's what you do to get it running: @@ -128,7 +135,7 @@ So, with all that in mind, here's what you do to get it running: REST API ======== -You can also submit a document using the REST API, see the API section for details. +You can also submit a document using the REST API, see :ref:`api-file_uploads` for details. .. _usage-recommended_workflow: