Update Changelog

Changelog.md

@@ -1,5 +1,112 @@
 # Changelog
 
+## v0.18.0
+
+*Soon*
+
+- Feature: Results summary and updated tag count (#496, #333)
+  - A search summary can be displayed that shows the overall result
+    count and to each custom field with a numeric type (number or
+    money) small statistics like sum, average and max/min values. This
+    is useful when you track your expenses on invoices or receipts.
+  - This additional ui element can be enabled/disabled in your ui
+    settings.
+  - The result summary is now also used to update the tag counts in
+    the search menu according to the current results.
+- Feature: password reset (#376,
+  [docs](https://docspell.org/docs/tools/reset-password/))
+  - Adds a new route for admins to reset the password of a user
+  - Admin users are those with access to the config file, the endpoint
+    requires to supply a secret from the config file.
+  - A bash script is provided for more convenient access.
+  - *Note this also moves the re-create index endpoint behind the same
+    secret!* See below.
+- Feature: custom fields clickable (#514)
+  - The item detail view allows to click on tags to quickly find all
+    tagged items. This now works for custom fields, too.
+- Feature: scroll independently (#541)
+  - The search menu can scroll now independent from the main area
+    containing the item cards.
+- Improvement: improve attachment selection (#396)
+  - When selecting an attachment, it shows its preview to the name
+    instead of the name only
+- Improvement: wildcard search for custom date fields (#550)
+  - Searching for custom field values allows to use a wildcard `*` at
+    beginning or end. This is also enabled for date-fields.
+- Improvement: joex memory (#509)
+  - Joex currently requires a lot of memory to hold the NLP models.
+    After idling for some time, which can be configured and defaults
+    to 15 min, the NLP model cache is cleared. This reduces memory
+    load and makes it possible for the JVM to give it back to the OS.
+  - This is supposed to relieve memory consumption when idling only.
+    However, whether it is reclaimed by the OS depends on the JVM and
+    its settings. To observe it early, use the G1GC garbage collector.
+    This is enabled by default for JDK11. So it is recommended to use
+    JDK11 (which is used in the docker images).
+- Improvement: allow scaling joex with docker-compose, thanks @bjeanes
+  (#552)
+  - This allows to easily start multiple joex containers via
+    `docker-compose`
+- Improvement: allow to connect with gmail via app specific passwords
+  (#520)
+  - Imap settings have been extended to be able to specify if a OAuth2
+    should be used or not.
+  - Before, OAuth2 was the default when the server has advertised it.
+    *This has been changed now, which means you need to adapt your
+    IMAP settings if you currently use OAuth2*
+- Fix: provide multiple possible date suggestions for English
+  documents (#561)
+- Fix: add missing language files to joex docker image (#525)
+- Fix: fix a bug that occurs when processing is restarted (i.e. after
+  a crash) (#530)
+- Fix: fix a bug in the ui where the mail connection field was not
+  correctly updated (#524)
+- Fix: fix bug when importing mails with an applied filter (#551)
+
+### Breaking Changes
+
+- Rest Server config:
+  - If you specify the `fulltext-search.recreate-key`, you need to
+    change your config. Delete it and use the secret now for the new
+    setting `admin-endpoint.secret`.
+- routes
+  - The route to drop and recreate the fulltext search index has been
+    moved. It is now at `/admin/fts/reIndexAll`. The secret must now
+    provided as http header and not in the url.
+- collective settings:
+  - The imap settings have a new flag which indicates whether OAuth2
+    auth mechanism should be prefered. This is `false` by default. If
+    you have used it with OAuth2 (like with gmail) you need either set
+    this flag to `true` manually or use an [application specific
+    password](https://docspell.org/docs/webapp/emailsettings/#via-app-specific-passwords).
+
+### REST Api Changes
+
+- Rest Server:
+  - Move endpoint `/open/fts/reIndexAll/{id}` to
+    `/admin/fts/reIndexAll`. The secret must now be specified via an
+    http header `Docspell-Admin-Secret`.
+  - Add `/admin/user/resetPassword` which requires a http header
+    `Docspell-Admin-Secret` with a value from the config file.
+  - Add `/sec/item/searchStats` to return a search result summary
+  - Changes `ImapSettings` to include a `useOAuth` flag
+  - Remove `fileCount` from the `TagCloud` structure
+  - The return value for `/sec/item/searchStats` now contains all
+    tags, before tags with `count == 0` were excluded
+  
+### Configuration Changes
+
+- Rest Server:
+  - adds `admin-endpoint.secret` (without any value) that is the
+    secret for the new "admin endpoint"
+  - Removes `full-text-search.recreate-key`, the route that was using
+    this key is now moved in the admin endpoint and therefore shares
+    this secret now.
+- Joex:
+  - adds `clear-stanford-nlp-interval = "15 minutes"` which is the
+    joex idle time to clear the nlp cache
+
+
 ## v0.17.1
 
 *Dec 15, 2020*

Contributing.md

@@ -0,0 +1,67 @@
+# Contributing
+
+Thank you very much for your interest in this project!
+
+Contributions are possible by various means.
+
+
+## Feedback
+
+Feedback is very important and most welcome! You can currently use the
+[issue tracker](https://github.com/eikek/docspell/issues/new) or the
+[gitter room](https://gitter.im/eikek/docspell) to leave feedback or
+say hi. You can also access the gitter room using your favorite
+[matrix](https://matrix.org/) client.
+
+If you don't like to sign up to github/matrix or like to reach me
+personally, you can make a mail to `info [at] docspell.org` or on
+matrix, via `@eikek:matrix.org`.
+
+
+## Documentation
+
+The website `https://docspell.org` contains the main documentation and
+is also hosted in this repository. The sources are in `/website`
+folder. It is built using [zola](https://github.com/getzola/zola), a
+static site generator.
+
+If you want to contribute to the documentation, please see the
+[README](https://github.com/eikek/docspell/blob/master/website/README.md)
+in this folder for how to get started. It is recommended to install
+[nix](https://nixos.org/guides/install-nix.html) in order to not
+fiddle with dependencies.
+
+The main content is in `/website/site/content` and sibling directories.
+
+There are always two versions of the website: the currently released
+version and the development version (which is becoming the next
+release). If you want to contribute to the current docs, please base
+your PR off the `current-docs` branch.
+
+
+## Code
+
+Code is very welcome, too, of course.
+
+If you want to work on something larger, please create an issue or
+let's discuss it on gitter first.
+
+The backend of docspell is written in [Scala](https://scala-lang.org)
+using a pure functional style. It builds on great libraries from the
+[typelevel](https://typelevel.org) ecosystem, i.e.
+[cats](https://typelevel.org/cats), [fs2](https://fs2.io),
+[doobie](https://tpolecat.github.io/doobie/) and
+[http4s](https://http4s.org/). The backend consists of two components:
+a http/rest server and the job executor, both running in separate
+processes.
+
+The web frontend is written in [Elm](https://elm-lang.org), which is a
+nice functional language that compiles to javascript. The frontend is
+included in the http/restserver component. The CSS is provided by
+[Fomantic-UI](https://fomantic-ui.com/), where a [custom
+build](https://github.com/eikek/fomantic-slim-default) of it is used
+to avoid dependency to a google font and jquery (all javascript
+modules are removed).
+
+The [development](https://docspell.org/docs/dev/building/) page
+contains some tips to get started.

README.md

@@ -84,7 +84,8 @@ room](https://gitter.im/eikek/docspell) for chatting and questions.
 You can also [open an
 issue](https://github.com/eikek/docspell/issues/new) for questions,
 problems and other feedback; or make a mail to `info [at]
-docspell.org`. I'll try to answer in time.
+docspell.org`. I'll try to answer in time. You may want to check
+[Contributing.md](Contributing.md) for some starting points, too.
 
 If you find this project any useful and want to support it via other
 means, giving a :star: is always encouraging and much appreciated. You