Skip to content

Commit 1b7f161

Browse files
authored
Update name in docs (paperless-ngx#80)
* Update name in docs Will document on paperless-ngx#52 what's left do do. * Update usage_overview.rst
1 parent dcb8c17 commit 1b7f161

11 files changed

+37
-37
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ assignees: ''
88
---
99

1010
<!---
11-
=> Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ng.readthedocs.io/en/latest/troubleshooting.html
11+
=> Before opening an issue, please check the documentation and see if it helps you resolve your issue: https://paperless-ngx.readthedocs.io/en/latest/troubleshooting.html
1212
=> Please also make sure that you followed the installation instructions.
1313
=> Please search the issues and look for similar issues before opening a bug report.
1414
15-
=> If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests
15+
=> If you would like to submit a feature request please submit one under https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests
1616
1717
=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably an issue with your system, and not an issue of paperless.
1818

.github/ISSUE_TEMPLATE/other.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ assignees: ''
1111
1212
=> Discussions, Feedback and other suggestions belong in the "Discussion" section and not on the issue tracker.
1313
14-
=> If you would like to submit a feature request please submit one under https://github.com/jonaswinkler/paperless-ng/discussions/categories/feature-requests
14+
=> If you would like to submit a feature request please submit one under https://github.com/paperless-ngx/paperless-ngx/discussions/categories/feature-requests
1515
1616
=> If you encounter issues while installing of configuring Paperless-ng, please post that in the "Support" section of the discussions. Remember that Paperless successfully runs on a variety of different systems. If paperless does not start, it's probably is an issue with your system, and not an issue of paperless.
1717

docs/administration.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ Updating Paperless
6464
Docker Route
6565
============
6666

67-
If a new release of paperless-ng is available, upgrading depends on how you
68-
installed paperless-ng in the first place. The releases are available at the
69-
`release page <https://github.com/jonaswinkler/paperless-ng/releases>`_.
67+
If a new release of paperless-ngx is available, upgrading depends on how you
68+
installed paperless-ngx in the first place. The releases are available at the
69+
`release page <https://github.com/paperless-ngx/paperless-ngx/releases>`_.
7070

7171
First of all, ensure that paperless is stopped.
7272

@@ -98,14 +98,14 @@ B. If you built the image yourself, do the following:
9898
9999
Running ``docker-compose up`` will also apply any new database migrations.
100100
If you see everything working, press CTRL+C once to gracefully stop paperless.
101-
Then you can start paperless-ng with ``-d`` to have it run in the background.
101+
Then you can start paperless-ngx with ``-d`` to have it run in the background.
102102

103103
.. note::
104104

105105
In version 0.9.14, the update process was changed. In 0.9.13 and earlier, the
106106
docker-compose files specified exact versions and pull won't automatically
107107
update to newer versions. In order to enable updates as described above, either
108-
get the new ``docker-compose.yml`` file from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
108+
get the new ``docker-compose.yml`` file from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_
109109
or edit the ``docker-compose.yml`` file, find the line that says
110110

111111
.. code::

docs/contributing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Contributing to Paperless
55

66
.. warning::
77

8-
This section is not updated to paperless-ng yet.
8+
This section is not updated to paperless-ngx yet.
99

1010
Maybe you've been using Paperless for a while and want to add a feature or two,
1111
or maybe you've come across a bug that you have some ideas how to solve. The

docs/extending.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Paperless development
44
#####################
55

6-
This section describes the steps you need to take to start development on paperless-ng.
6+
This section describes the steps you need to take to start development on paperless-ngx.
77

88
Check out the source from github. The repository is organized in the following way:
99

docs/faq.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ out of that folder to use them elsewhere. Here are a couple notes about that.
4545
:ref:`configuring the filename format <advanced-file_name_handling>`.
4646
* :ref:`The exporter <utilities-exporter>` is another easy way to get your files out of paperless with reasonable file names.
4747

48-
**Q:** *What file types does paperless-ng support?*
48+
**Q:** *What file types does paperless-ngx support?*
4949

5050
**A:** Currently, the following files are supported:
5151

@@ -58,7 +58,7 @@ out of that folder to use them elsewhere. Here are a couple notes about that.
5858
Paperless determines the type of a file by inspecting its content. The
5959
file extensions do not matter.
6060

61-
**Q:** *Will paperless-ng run on Raspberry Pi?*
61+
**Q:** *Will paperless-ngx run on Raspberry Pi?*
6262

6363
**A:** The short answer is yes. I've tested it on a Raspberry Pi 3 B.
6464
The long answer is that certain parts of
@@ -73,7 +73,7 @@ in your browser and paperless has to do much less work to serve the data.
7373
power. See :ref:`setup-less_powerful_devices` for details.
7474

7575

76-
**Q:** *How do I install paperless-ng on Raspberry Pi?*
76+
**Q:** *How do I install paperless-ngx on Raspberry Pi?*
7777

7878
**A:** Docker images are available for arm and arm64 hardware, so just follow
7979
the docker-compose instructions. Apart from more required disk space compared to

docs/index.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ repository right away.
3232

3333
NG stands for both Angular (the framework used for the
3434
Frontend) and next-gen. Publishing this project under a different name also
35-
avoids confusion between paperless and paperless-ng.
35+
avoids confusion between paperless and paperless-ngx.
3636

37-
If you want to learn about what's different in paperless-ng, check out these
37+
If you want to learn about what's different in paperless-ngx, check out these
3838
resources in the documentation:
3939

4040
* :ref:`Some screenshots <screenshots>` of the new UI are available.
@@ -46,12 +46,12 @@ resources in the documentation:
4646
the consumption directory. This means that you can select text in
4747
image-only documents coming from your scanner.
4848
* See :ref:`this note <utilities-encyption>` about GnuPG encryption in
49-
paperless-ng.
49+
paperless-ngx.
5050
* Paperless is now integrated with a
5151
:ref:`task processing queue <setup-task_processor>` that tells you
5252
at a glance when and why something is not working.
5353
* The :ref:`changelog <paperless_changelog>` contains a detailed list of all changes
54-
in paperless-ng.
54+
in paperless-ngx.
5555

5656
It would be great if this project could eventually merge back into the main
5757
repository, but it needs a lot more work before that can happen.

docs/screenshots.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Screenshots
55
***********
66

7-
This is what paperless-ng looks like. You shouldn't use paperless to index
7+
This is what paperless-ngx looks like. You shouldn't use paperless to index
88
research papers though, its a horrible tool for that job.
99

1010
The dashboard shows customizable views on your document and allows document uploads:

docs/setup.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Setup
66
Overview of Paperless-ng
77
########################
88

9-
Compared to paperless, paperless-ng works a little different under the hood and has
9+
Compared to paperless, paperless-ngx works a little different under the hood and has
1010
more moving parts that work together. While this increases the complexity of
1111
the system, it also brings many benefits.
1212

@@ -125,7 +125,7 @@ Install Paperless from Docker Hub
125125

126126
1. Login with your user and create a folder in your home-directory `mkdir -v ~/paperless-ng` to have a place for your configuration files and consumption directory.
127127

128-
2. Go to the `/docker/compose directory on the project page <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`_
128+
2. Go to the `/docker/compose directory on the project page <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`_
129129
and download one of the `docker-compose.*.yml` files, depending on which database backend you
130130
want to use. Rename this file to `docker-compose.yml`.
131131
If you want to enable optional support for Office documents, download a file with `-tika` in the file name.
@@ -244,7 +244,7 @@ Build the Docker image yourself
244244

245245
.. code:: shell-session
246246
247-
git clone https://github.com/jonaswinkler/paperless-ng
247+
git clone https://github.com/paperless-ngx/paperless-ngx
248248
249249
The master branch always reflects the latest stable version.
250250

@@ -338,7 +338,7 @@ writing. Windows is not and will never be supported.
338338
3. Optional. Install ``postgresql`` and configure a database, user and password for paperless. If you do not wish
339339
to use PostgreSQL, SQLite is available as well.
340340

341-
4. Get the release archive from `<https://github.com/jonaswinkler/paperless-ng/releases>`_.
341+
4. Get the release archive from `<https://github.com/paperless-ngx/paperless-ngx/releases>`_.
342342
If you clone the git repo as it is, you also have to compile the front end by yourself.
343343
Extract the archive to a place from where you wish to execute it, such as ``/opt/paperless``.
344344

@@ -483,7 +483,7 @@ Install Paperless using ansible
483483
Additionally, only i386 or amd64 based hosts are supported right now, i.e. installation on arm hosts will fail.
484484

485485
1. Install ansible 2.7+ on the management node.
486-
This may be the target host paperless-ng is being installed on or any remote host which can access the target host.
486+
This may be the target host paperless-ngx is being installed on or any remote host which can access the target host.
487487
For further details, check the ansible `inventory <https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html>`_ documentation.
488488

489489
On Debian and Ubuntu, the official repositories should provide a suitable version:
@@ -580,12 +580,12 @@ Install Paperless using ansible
580580
581581
ansible-playbook playbook.yml
582582
583-
When this step completes successfully, paperless-ng will be available on the target host at ``http://127.0.0.1:8000`` (or the address you configured).
583+
When this step completes successfully, paperless-ngx will be available on the target host at ``http://127.0.0.1:8000`` (or the address you configured).
584584

585-
Migration to paperless-ng
585+
Migration to paperless-ngx
586586
#########################
587587

588-
At its core, paperless-ng is still paperless and fully compatible. However, some
588+
At its core, paperless-ngx is still paperless and fully compatible. However, some
589589
things have changed under the hood, so you need to adapt your setup depending on
590590
how you installed paperless.
591591

@@ -601,10 +601,10 @@ The important things to keep in mind are as follows:
601601
such as email checking and maintenance, requires a `redis`_ message broker
602602
instance. The docker-compose route takes care of that.
603603
* The layout of the folder structure for your documents and data remains the
604-
same, so you can just plug your old docker volumes into paperless-ng and
604+
same, so you can just plug your old docker volumes into paperless-ngx and
605605
expect it to find everything where it should be.
606606

607-
Migration to paperless-ng is then performed in a few simple steps:
607+
Migration to paperless-ngx is then performed in a few simple steps:
608608

609609
1. Stop paperless.
610610

@@ -614,20 +614,20 @@ Migration to paperless-ng is then performed in a few simple steps:
614614
$ docker-compose down
615615
616616
2. Do a backup for two purposes: If something goes wrong, you still have your
617-
data. Second, if you don't like paperless-ng, you can switch back to
617+
data. Second, if you don't like paperless-ngx, you can switch back to
618618
paperless.
619619

620-
3. Download the latest release of paperless-ng. You can either go with the
621-
docker-compose files from `here <https://github.com/jonaswinkler/paperless-ng/tree/master/docker/compose>`__
620+
3. Download the latest release of paperless-ngx. You can either go with the
621+
docker-compose files from `here <https://github.com/paperless-ngx/paperless-ngx/tree/master/docker/compose>`__
622622
or clone the repository to build the image yourself (see :ref:`above <setup-docker_build>`).
623-
You can either replace your current paperless folder or put paperless-ng
623+
You can either replace your current paperless folder or put paperless-ngx
624624
in a different location.
625625

626626
.. caution::
627627

628628
Paperless-ng includes a ``.env`` file. This will set the
629629
project name for docker compose to ``paperless``, which will also define the name
630-
of the volumes by paperless-ng. However, if you experience that paperless-ng
630+
of the volumes by paperless-ngx. However, if you experience that paperless-ngx
631631
is not using your old paperless volumes, verify the names of your volumes with
632632

633633
.. code:: shell-session
@@ -657,7 +657,7 @@ Migration to paperless-ng is then performed in a few simple steps:
657657
This will migrate your database and create the search index. After that,
658658
paperless will take care of maintaining the index by itself.
659659

660-
8. Start paperless-ng.
660+
8. Start paperless-ngx.
661661

662662
.. code:: bash
663663

docs/usage_overview.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ which not only has document upload, but also document browsing and download feat
126126
IMAP (Email)
127127
============
128128

129-
You can tell paperless-ng to consume documents from your email accounts.
130-
This is a very flexible and powerful feature if you regularly received documents
129+
You can tell paperless-ngx to consume documents from your email accounts.
130+
This is a very flexible and powerful feature, if you regularly received documents
131131
via mail that you need to archive. The mail consumer can be configured by using the
132132
admin interface in the following manner:
133133

resources/logo.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
SilN@@@@@@@
66
*Q *@@@@@@@@S /= = = = = = = = = = = = = = = = = =\
77
*@ B@@@@@@@@N || ||
8-
N R$ A@@@@@@@@@@ || PAPERLESS-NG ||
8+
N R$ A@@@@@@@@@@ || PAPERLESS-NGX ||
99
x@@ $U B@@@@@@@@@R || ||
1010
N@@N^ @ N@@@@@@@@@* \= = = = = = = = = = = = = = = = = =/
1111
|@@@u @ E@@@@@@@@l

0 commit comments

Comments
 (0)