From 4091130908271e18fde36c48b0b53851ab91911a Mon Sep 17 00:00:00 2001 From: eikek Date: Mon, 7 Jun 2021 22:47:24 +0200 Subject: [PATCH 1/7] Fix documentation about the current job page --- website/site/content/docs/webapp/processing.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/website/site/content/docs/webapp/processing.md b/website/site/content/docs/webapp/processing.md index e20ad5ba..06cf9740 100644 --- a/website/site/content/docs/webapp/processing.md +++ b/website/site/content/docs/webapp/processing.md @@ -7,13 +7,13 @@ mktoc = true The page *Processing Queue* shows the current state of document -processing for your uploads. +processing for your uploads. The page currently only shows at most the +80 newest jobs. There is a maximum of 40 done jobs (successful, +cancelled or failed) and 40 not done jobs. -At the top of the page a list of running jobs is shown. Below that, -the left column shows jobs that wait to be picked up by the job -executor. On the right are finished jobs. The number of finished jobs -is cut to some maximum and is also restricted by a date range. The -page refreshes itself automatically to show the progress. +The sidebar lets you filter for a specific job state. The *Currently +Running* tab shows all jobs that are currently executing and their log +output. The page refreshes automatically to show the progress. Example screenshot: @@ -32,8 +32,9 @@ Since job executors are shared among all collectives, it may happen that a job is some time waiting until it is picked up by a job executor. You can always start more job executors to help out. -If a job fails, it is retried after some time. Only if it fails too -often (can be configured), it then is finished with *failed* state. +If a job fails it first enters "stuck" state and is retried after some +time. Only if it fails too often (can be configured), it then is +finished with *failed* state. For the document-processing task, if processing finally fails or a job is cancelled, the item is still created, just without suggestions. From 808bd42b773b7dcd2d93c8abbed7c11dea290945 Mon Sep 17 00:00:00 2001 From: eikek Date: Sat, 19 Jun 2021 00:13:43 +0200 Subject: [PATCH 2/7] Fix dead link --- website/site/content/docs/faq/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/site/content/docs/faq/_index.md b/website/site/content/docs/faq/_index.md index fa25bcc1..84ee520f 100644 --- a/website/site/content/docs/faq/_index.md +++ b/website/site/content/docs/faq/_index.md @@ -117,8 +117,7 @@ Please see this [issue](https://github.com/eikek/docspell/issues/358). ## Why another DMS? Back when Docspell started, there weren't as many options as there are -now. I wanted to try out a different approach. You can read more about -that [here](@/docs/intro/_index.md#rationale). +now. I wanted to try out a different approach. ## Wh…? From bd187d4f9dd9cec200699bf259c7c54e551c9546 Mon Sep 17 00:00:00 2001 From: eikek Date: Sat, 19 Jun 2021 00:18:16 +0200 Subject: [PATCH 3/7] Some external links that are just now temporarily not available --- build.sbt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build.sbt b/build.sbt index 2205fe5c..5201e975 100644 --- a/build.sbt +++ b/build.sbt @@ -788,5 +788,5 @@ addCommandAlias( "restapi/openapiLint; joexapi/openapiLint; scalafmtSbtCheck; scalafmtCheckAll; Compile/scalafix --check; Test/scalafix --check" ) addCommandAlias("fix", "Compile/scalafix; Test/scalafix; scalafmtSbt; scalafmtAll") -addCommandAlias("make-website", ";website/clean ;website/zolaBuild ;website/zolaCheck") +addCommandAlias("make-website", ";website/clean ;website/zolaBuild") addCommandAlias("publish-website", "website/publishToGitHubPages") From cfda9b470e35aee15789bd2b77327556dadd19db Mon Sep 17 00:00:00 2001 From: eikek Date: Sat, 19 Jun 2021 00:22:30 +0200 Subject: [PATCH 4/7] Fix publishing website by github actions --- .github/workflows/website.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index 410ee5e4..8371508c 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -23,4 +23,6 @@ jobs: - name: Build website (${{ env.DOCSPELL_VERSION }}) run: nix-shell website/shell.nix --run "sbt make-website" - name: Publish website (${{ env.DOCSPELL_VERSION }}) + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: sbt publish-website From 207bb7138a17c9d3ed3f368c9481ecd037d50a2e Mon Sep 17 00:00:00 2001 From: eikek Date: Sat, 17 Jul 2021 13:05:43 +0200 Subject: [PATCH 5/7] Mention another change in docker images in 0.24.0 --- Changelog.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Changelog.md b/Changelog.md index e524128a..17d19d5d 100644 --- a/Changelog.md +++ b/Changelog.md @@ -59,6 +59,10 @@ state (the master branch). The `latest` tag points to the latest release. Each release is also tagged with its version number, like `v0.24.0`. +The images changed slightly in that there is no assumption on where +the config file is placed. Now you need to pass the docspell config +file explicitely when using the images. + Multiarch: Images are now build for `amd64`, `arm64` and `armv7`. The consumedir is being replaced by the more generic `docspell/tools` @@ -78,7 +82,10 @@ The docker-compose setup is now at `docker/docker-compose`. Please look at the new [compose file](https://github.com/eikek/docspell/blob/master/docker/docker-compose/docker-compose.yml) and do the corresponding changes at yours. Especially the consumedir -container changed significantly. +container changed significantly. Then due to the fact that the config +file must be given explicitely, you need to add this argument to each +docspell component (restserver and joex) via a `command` section (see +the compose file referenced above). The `.envrc` has been cleaned from some settings. Since the config files is mounted into the image, you can just edit this file instead. From cd304bcff7c05bdb600db7cef9c9a1d369748cf0 Mon Sep 17 00:00:00 2001 From: eikek Date: Wed, 14 Jul 2021 22:32:17 +0200 Subject: [PATCH 6/7] Improve doc string for some endpoints --- .../restapi/src/main/resources/docspell-openapi.yml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/modules/restapi/src/main/resources/docspell-openapi.yml b/modules/restapi/src/main/resources/docspell-openapi.yml index 5a4a6a03..59d5fc66 100644 --- a/modules/restapi/src/main/resources/docspell-openapi.yml +++ b/modules/restapi/src/main/resources/docspell-openapi.yml @@ -2764,7 +2764,7 @@ paths: head: operationId: "sec-attach-check-original" tags: [ Attachment ] - summary: Get an attachment file. + summary: Get headers of the original file of an attachment. description: | Get information about the original binary file of the attachment with the given id. @@ -2795,7 +2795,7 @@ paths: get: operationId: "sec-attach-get-original" tags: [ Attachment ] - summary: Get an attachment file. + summary: Get the original file of an attachment. description: | Get the original binary file of the attachment with the given id. @@ -2818,7 +2818,7 @@ paths: head: operationId: "sec-attach-check-archive" tags: [ Attachment ] - summary: Get an attachment archive file. + summary: Get headers of the archive file to an attachment. description: | Get information about the archive that contains the attachment with the given id. @@ -2849,7 +2849,7 @@ paths: get: operationId: "sec-attach-get-archive" tags: [ Attachment ] - summary: Get an attachment archive file. + summary: Get the archive file of an attachment. description: | Get the archive file that was originally uploaded that contains the attachment with the given id. @@ -2872,7 +2872,7 @@ paths: head: operationId: "sec-attach-check-preview" tags: [ Attachment ] - summary: Get a preview image of an attachment file. + summary: Get the headers to a preview image of an attachment file. description: | Checks if an image file showing a preview of the attachment is available. If not available, a 404 is returned. @@ -5484,6 +5484,7 @@ components: - date - source - tags + - attachments properties: id: type: string From 88496e792a5703e178e6104e98d00a039f45282a Mon Sep 17 00:00:00 2001 From: eikek Date: Sat, 17 Jul 2021 13:16:46 +0200 Subject: [PATCH 7/7] Fix dead link in docs --- Changelog.md | 2 +- build.sbt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Changelog.md b/Changelog.md index 17d19d5d..4f465b14 100644 --- a/Changelog.md +++ b/Changelog.md @@ -917,7 +917,7 @@ improvements for processing files. upload the file into memory for nothing if something fails (e.g. the source doesn't exist) - Re-process files. A - [route](https://docspell.org/openapi/docspell-openapi.html#api-Item-secItemItemIdReprocessPost) + [route](https://docspell.org/openapi/docspell-openapi.html#operation/sec-item-start-reprocess) has been added that submits files for re-processing. It is possible to re-process some files of an item or all. There is no UI for this for now. You'd need to run `curl` or something manually to trigger diff --git a/build.sbt b/build.sbt index 5201e975..2205fe5c 100644 --- a/build.sbt +++ b/build.sbt @@ -788,5 +788,5 @@ addCommandAlias( "restapi/openapiLint; joexapi/openapiLint; scalafmtSbtCheck; scalafmtCheckAll; Compile/scalafix --check; Test/scalafix --check" ) addCommandAlias("fix", "Compile/scalafix; Test/scalafix; scalafmtSbt; scalafmtAll") -addCommandAlias("make-website", ";website/clean ;website/zolaBuild") +addCommandAlias("make-website", ";website/clean ;website/zolaBuild ;website/zolaCheck") addCommandAlias("publish-website", "website/publishToGitHubPages")