paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-10-30 03:56:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

more docs

Browse Source
This commit is contained in:
Jonas Winkler
2020-11-13 21:06:05 +01:00
parent 496a4f8f0f
commit 32e481c02f
6 changed files with 34 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/administration.rst
View File

@@ -9,7 +9,7 @@ Making backups
.. warning:: .. 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 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 your files for whatever reason. This is easy to do, simply use the
@@ -22,6 +22,7 @@ into an arbitrary directory.
Restoring Restoring
========= =========
.. _administration-updating: .. _administration-updating:
Updating paperless Updating paperless

8
docs/api.rst
View File

@@ -5,7 +5,7 @@ The REST API
.. warning:: .. 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 Paperless makes use of the `Django REST Framework`_ standard API interface
because of its inherent awesomeness. Conveniently, the system is also because of its inherent awesomeness. Conveniently, the system is also
@@ -16,8 +16,10 @@ installation.
.. _Django REST Framework: http://django-rest-framework.org/ .. _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 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 no standard way of accepting them, so rather than crowbar file uploads into the

4
docs/contributing.rst
View File

@@ -3,6 +3,10 @@
Contributing to Paperless 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, 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 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 beauty of Free software is that you can see what's wrong and help to get it

4
docs/extending.rst
View File

@@ -3,6 +3,10 @@
Extending Paperless 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 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 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 `GitHub`_. However, over time the project has been evolving to be a little

3
docs/troubleshooting.rst
View File

@@ -2,6 +2,9 @@
Troubleshooting Troubleshooting
*************** ***************
.. warning::
This section is not updated to paperless-ng yet.
Consumer warns ``OCR for XX failed`` Consumer warns ``OCR for XX failed``
#################################### ####################################

19
docs/usage_overview.rst
View File

@@ -94,15 +94,22 @@ pull emails down from an arbitrary account and dump them into the consumption
directory where the consumer will follow the directory where the consumer will follow the
usual pattern on consuming the document. 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 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
It's been tested in a limited environment, so it may not work for you (please
submit a pull request if you can!) submit a pull request if you can!)
* It's designed to **delete mail from the server once consumed**. So don't go
.. 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 pointing this to your personal email account and wonder where all your stuff
went. went.
* Currently, only one photo (attachment) per email will work.
.. 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: 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 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: .. _usage-recommended_workflow: