From b036c8669a78eca15fff9d41ddb640524eaa822a Mon Sep 17 00:00:00 2001 From: hygienic-books Date: Wed, 17 May 2023 01:51:35 +0200 Subject: [PATCH] refactor(paperless-ngx): Typos --- paperless_ngx/README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/paperless_ngx/README.md b/paperless_ngx/README.md index 94a09ed..beeaaa9 100644 --- a/paperless_ngx/README.md +++ b/paperless_ngx/README.md @@ -2,7 +2,7 @@ ## Defaults -We use the [upstream github.com/paperless-ngx/paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) repo. Assuming you have this checked out at `/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main`. The `COMPOSE_CTX` (`CTX` as in context) is a uniq identifier to differentiate one instance from another. This can be for example `hr_juba` to indicate that this particular instance runs on behalf of the Human Resources department based in Juba in South Sudan in Africa. +We use the [upstream github.com/paperless-ngx/paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) repo assuming you have this checked out at `/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev`. The `COMPOSE_CTX` (`CTX` as in context) is a unique identifier to differentiate one instance from another. This can be for example `hr_juba` to indicate that this particular instance runs on behalf of the Human Resources department based in Juba in South Sudan in Africa. Examples assume we're using the `docker-compose.postgres-tika.yml` file which spins up PostgreSQL as its database and also provides [Apache Tika](https://tika.apache.org/) and [Gotenberg PDF API](https://gotenberg.dev/docs/about). @@ -10,8 +10,8 @@ Examples assume we're using the `docker-compose.postgres-tika.yml` file which sp * Set env vars ``` - export COMPOSE_DIR='/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main/docker/compose' - export COMPOSE_CTX=''"${COMPOSE_CTX}"'' + export COMPOSE_DIR='/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev/docker/compose' + export COMPOSE_CTX='hr_juba' export COMPOSE_PROJECT_NAME='paperless_ngx-'"${COMPOSE_CTX}" export COMPOSE_FILE="${COMPOSE_DIR%/}"'/docker-compose.postgres-tika.yml' export COMPOSE_ENV_FILE= @@ -54,13 +54,13 @@ To get started from scratch create your ZFS datasets and set permissions as need Identify yourself to the local `paperless-ngx` repo. Obviously substitute your own name. An e-mail address is optional here. You don't want to contribute upstream, you just want to locally apply a patch file. ``` -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' config user.name "hygienic-books" -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' config user.email "" +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' config user.name "hygienic-books" +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' config user.email "" ``` Apply `paperless_ngx.patch` to Docker Compose file. We use the `docker-compose.postgres-tika.yml` Compose file. Assuming this repo lives at `/opt/containers/paperless_ngx`: ``` -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' am '/opt/containers/paperless_ngx/paperless_ngx.patch' +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' am '/opt/containers/paperless_ngx/paperless_ngx.patch' # Output will be: Applying: refactor(compose): 4 spaces indentation @@ -81,13 +81,13 @@ Check [Prep work](#prep-work) for first time steps. On consecutive upgrades proc Return repo state to exactly the upstream repo's original branch state throwing away the commits you added. ``` -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' reset --hard origin +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' reset --hard origin ``` Switch to `main` branch, get newest commits from upstream ``` -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' checkout main -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' pull +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' checkout dev +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' pull ``` Pick and checkout new tag @@ -103,7 +103,7 @@ while IFS= read -r; do commitDate=$(grep -Pio '^.+?(?=[[:space:]])' <<< "${REPLY 2023-05-15-170859 3e129763c799a7141e5ecd04862c0160caeeef5b v1.14.5 ... -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' checkout 'tags/vx.y.z' +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' checkout 'tags/vx.y.z' ``` Lastly [apply patch](#apply-patch). If patch does not apply cleanly read on in the next section [Create new patch](#create-new-patch) to find out how to fix your patch. @@ -112,9 +112,9 @@ Lastly [apply patch](#apply-patch). If patch does not apply cleanly read on in t ## Add your changes as commits -With `paperless-ngx` repo checked out at `/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main` get the it into a state with which you're happy then +With `paperless-ngx` repo checked out at `/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev` get the it into a state with which you're happy then ``` -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' format-patch 31b7e26f6c4d7111f4f4957996efb9f7a5d06cb9^..64beae08ffe8f9a65208e2567919fd75564b95c6 --stdout > '/opt/containers/paperless_ngx/paperless_ngx.patch' +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' format-patch 31b7e26f6c4d7111f4f4957996efb9f7a5d06cb9^..64beae08ffe8f9a65208e2567919fd75564b95c6 --stdout > '/opt/containers/paperless_ngx/paperless_ngx.patch' ``` Where the first commit hash is our first commit and the other commit hash is our last commit. Note the caret (`^`) right after the first commit hash. @@ -139,7 +139,7 @@ while IFS= read -r; do commitDate=$(grep -Pio '^.+?(?=[[:space:]])' <<< "${REPLY Diff them ``` -git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/main' diff ec4814a76e88efa81387316d8c42afc7e220fcbe 3e129763c799a7141e5ecd04862c0160caeeef5b 'docker/compose/docker-compose.postgres-tika.yml' +git -C '/opt/git/github.com/paperless-ngx/paperless-ngx/branches/dev' diff ec4814a76e88efa81387316d8c42afc7e220fcbe 3e129763c799a7141e5ecd04862c0160caeeef5b 'docker/compose/docker-compose.postgres-tika.yml' ``` Output will be empty in case no difference exists in `docker/compose/docker-compose.postgres-tika.yml` between both commit hashes.