From 2a1c6bf0cad0005424b93591bb4634fa276c45e1 Mon Sep 17 00:00:00 2001
From: Malte Breitzmann <22179782+vossmalte@users.noreply.github.com>
Date: Sat, 4 Jan 2025 01:30:25 +0100
Subject: [PATCH] Documentation: remove dollar sign in code snippets (#8600)

---
 docs/administration.md  | 16 ++++++++--------
 docs/configuration.md   |  4 ++--
 docs/development.md     | 24 ++++++++++++------------
 docs/setup.md           | 20 ++++++++++----------
 docs/troubleshooting.md |  2 +-
 docs/usage.md           |  8 ++++----
 6 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/docs/administration.md b/docs/administration.md
index 0c852e667..8e646b326 100644
--- a/docs/administration.md
+++ b/docs/administration.md
@@ -81,8 +81,8 @@ $ docker compose down
 1.  If you pull the image from the docker hub, all you need to do is:
 
     ```shell-session
-    $ docker compose pull
-    $ docker compose up
+    docker compose pull
+    docker compose up
     ```
 
     The Docker Compose files refer to the `latest` version, which is
@@ -91,9 +91,9 @@ $ docker compose down
 1.  If you built the image yourself, do the following:
 
     ```shell-session
-    $ git pull
-    $ docker compose build
-    $ docker compose up
+    git pull
+    docker compose build
+    docker compose up
     ```
 
 Running `docker compose up` will also apply any new database migrations.
@@ -155,7 +155,7 @@ following:
     environment before that, if you use one.
 
     ```shell-session
-    $ pip install -r requirements.txt
+    pip install -r requirements.txt
     ```
 
     !!! note
@@ -168,8 +168,8 @@ following:
 3.  Migrate the database.
 
     ```shell-session
-    $ cd src
-    $ python3 manage.py migrate # (1)
+    cd src
+    python3 manage.py migrate # (1)
     ```
 
     1.  Including `sudo -Hu <paperless_user>` may be required
diff --git a/docs/configuration.md b/docs/configuration.md
index a329bf844..671e289b0 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1519,7 +1519,7 @@ one pod).
 actual user ID on the host system, which you can get by executing
 
     ``` shell-session
-    $ id -u
+    id -u
     ```
 
     Paperless will change ownership on its folders to this user, so you
@@ -1534,7 +1534,7 @@ actual user ID on the host system, which you can get by executing
 actual group ID on the host system, which you can get by executing
 
     ``` shell-session
-    $ id -g
+    id -g
     ```
 
     Paperless will change ownership on its folders to this group, so you
diff --git a/docs/development.md b/docs/development.md
index 53f4ee596..11223d9f3 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -69,13 +69,13 @@ first-time setup.
 3.  Create `consume` and `media` directories:
 
     ```bash
-    $ mkdir -p consume media
+    mkdir -p consume media
     ```
 
 4.  Install the Python dependencies:
 
     ```bash
-    $ pipenv install --dev
+    pipenv install --dev
     ```
 
     !!! note
@@ -85,7 +85,7 @@ first-time setup.
 5.  Install pre-commit hooks:
 
     ```bash
-    $ pre-commit install
+    pre-commit install
     ```
 
 6.  Apply migrations and create a superuser for your development instance:
@@ -93,8 +93,8 @@ first-time setup.
     ```bash
     # src/
 
-    $ python3 manage.py migrate
-    $ python3 manage.py createsuperuser
+    python3 manage.py migrate
+    python3 manage.py createsuperuser
     ```
 
 7.  You can now either ...
@@ -108,7 +108,7 @@ first-time setup.
     -   spin up a bare redis container
 
         ```
-        $ docker run -d -p 6379:6379 --restart unless-stopped redis:latest
+        docker run -d -p 6379:6379 --restart unless-stopped redis:latest
         ```
 
 8.  Continue with either back-end or front-end development – or both :-).
@@ -176,7 +176,7 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 1.  Install the Angular CLI. You might need sudo privileges to perform this command:
 
     ```bash
-    $ npm install -g @angular/cli
+    npm install -g @angular/cli
     ```
 
 2.  Make sure that it's on your path.
@@ -184,13 +184,13 @@ The front end is built using AngularJS. In order to get started, you need Node.j
 3.  Install all necessary modules:
 
     ```bash
-    $ npm install
+    npm install
     ```
 
 4.  You can launch a development server by running:
 
     ```bash
-    $ ng serve
+    ng serve
     ```
 
     This will automatically update whenever you save. However, in-place
@@ -335,13 +335,13 @@ If you want to build the documentation locally, this is how you do it:
 1.  Have an active pipenv shell (`pipenv shell`) and install Python dependencies:
 
     ```bash
-    $ pipenv install --dev
+    pipenv install --dev
     ```
 
 2.  Build the documentation
 
     ```bash
-    $ mkdocs build --config-file mkdocs.yml
+    mkdocs build --config-file mkdocs.yml
     ```
 
     _alternatively..._
@@ -352,7 +352,7 @@ If you want to build the documentation locally, this is how you do it:
     something.
 
     ```bash
-    $ mkdocs serve
+    mkdocs serve
     ```
 
 ## Building the Docker image
diff --git a/docs/setup.md b/docs/setup.md
index 25e977130..a60344039 100644
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -35,7 +35,7 @@ steps described in [Docker setup](#docker_hub) automatically.
 2.  Download and run the installation script:
 
     ```shell-session
-    $ bash -c "$(curl --location --silent --show-error https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
+    bash -c "$(curl --location --silent --show-error https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)"
     ```
 
     !!! note
@@ -49,7 +49,7 @@ steps described in [Docker setup](#docker_hub) automatically.
     configuration files and consumption directory.
 
     ```shell-session
-    $ mkdir -v ~/paperless-ngx
+    mkdir -v ~/paperless-ngx
     ```
 
 2.  Go to the [/docker/compose directory on the project
@@ -180,13 +180,13 @@ steps described in [Docker setup](#docker_hub) automatically.
     execute the following command:
 
     ```shell-session
-    $ docker compose run --rm webserver createsuperuser
+    docker compose run --rm webserver createsuperuser
     ```
 
     or using docker exec from within the container:
 
     ```shell-session
-    $ python3 manage.py createsuperuser
+    python3 manage.py createsuperuser
     ```
 
     This will prompt you to set a username, an optional e-mail address
@@ -238,7 +238,7 @@ steps described in [Docker setup](#docker_hub) automatically.
     `docker compose pull` to pull the image, do
 
     ```shell-session
-    $ docker compose build
+    docker compose build
     ```
 
     instead to build the image.
@@ -607,8 +607,8 @@ Migration to paperless-ngx is then performed in a few simple steps:
 1.  Stop paperless.
 
     ```bash
-    $ cd /path/to/current/paperless
-    $ docker compose down
+    cd /path/to/current/paperless
+    docker compose down
     ```
 
 2.  Do a backup for two purposes: If something goes wrong, you still
@@ -632,7 +632,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
         names of your volumes with
 
         ``` shell-session
-        $ docker volume ls | grep _data
+        docker volume ls | grep _data
         ```
 
         and adjust the project name in the `.env` file so that it matches
@@ -653,7 +653,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
     the search index:
 
     ```shell-session
-    $ docker compose run --rm webserver document_index reindex
+    docker compose run --rm webserver document_index reindex
     ```
 
     This will migrate your database and create the search index. After
@@ -662,7 +662,7 @@ Migration to paperless-ngx is then performed in a few simple steps:
 8.  Start paperless-ngx.
 
     ```bash
-    $ docker compose up -d
+    docker compose up -d
     ```
 
     This will run paperless in the background and automatically start it
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index b18ded26d..394832e33 100644
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -18,7 +18,7 @@ Check for the following issues:
     automatically. Manually invoke the task processor by executing
 
     ```shell-session
-    $ celery --app paperless worker
+    celery --app paperless worker
     ```
 
 -   Look at the output of paperless and inspect it for any errors.
diff --git a/docs/usage.md b/docs/usage.md
index cf4970e3c..504aae9ef 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -788,8 +788,8 @@ Paperless-ngx consists of the following components:
     with paperless. You may start the webserver directly with
 
     ```shell-session
-    $ cd /path/to/paperless/src/
-    $ gunicorn -c ../gunicorn.conf.py paperless.wsgi
+    cd /path/to/paperless/src/
+    gunicorn -c ../gunicorn.conf.py paperless.wsgi
     ```
 
     or by any other means such as Apache `mod_wsgi`.
@@ -804,8 +804,8 @@ Paperless-ngx consists of the following components:
     Start the consumer with the management command `document_consumer`:
 
     ```shell-session
-    $ cd /path/to/paperless/src/
-    $ python3 manage.py document_consumer
+    cd /path/to/paperless/src/
+    python3 manage.py document_consumer
     ```
 
 -   **The task processor:** Paperless relies on [Celery - Distributed