Fix microsite and add changelog

This commit is contained in:
Eike Kettner 2020-02-27 23:58:43 +01:00
parent e9a7ed27ec
commit ad8d64eded
4 changed files with 87 additions and 4 deletions

73
Changelog.md Normal file
View File

@ -0,0 +1,73 @@
# Changelog
## v0.3.0
- Support for many more document types has been added (including
images and office documents). All input files are converted into PDF
files (the original file is preserved).
- PDF Text extraction improved by omitting OCR if text can be
stripped.
- There is a new PDF viewer (utilizing viewerjs) that also works in
mobile browsers.
- Improve editing notes: Since notes may evolve, there is now a larger
edit form and a markdown preview.
- Show the extracted information (text, labels, proposals) of an
attachment in the Webui.
- The name search now also searches in item notes.
- Bug fixed where it was possible to create invalid input when
creating new sources.
- Bug fixed where the item menu was not properly initialized for
equipments.
- The `ds.sh` script has now an option to check a file for existence
in docspell.
### Configuration Changes
The configuration of the joex component has been changed.
- removed `docspell.joex.extraction.allowed-content-types`
- other settings in `docspell.joex.extraction` have been moved to
`docspell.joex.extraction.ocr`
- added `docspell.joex.extraction.ocr.max-image-size`
- added `docspell.joex.extraction.pdf.min-text-len`
- added sections in `docspell.joex.convert` for pdf conversion
settings
### REST Api Changes
The REST Api has some additions:
- new route to retrieve the original file
- new route to get the rendered pdf of an attachment (using viewerjs)
- add field in `ItemDetail` data that refers to the original files of
the attachments
## v0.2.0
*Jan. 12, 2020*
The second release of Docspell addresses some annoying issues in the
UI and adds a "send by email" feature.
- Send an item and its attachments via E-Mail (requires to setup SMTP
settings per user)
- Add a search field for meta data
- The item detail view is now a perma-link
- New endpoints to check whether a file is in Docspell by using their
SHA-256 checksum (see the api doc here and here), the scripts in
tools/ now use this endpoint to skip existing files
- Better support multiple attachments with long names in the UI
- Fixes textarea updating issues
## v0.1.0
*Sep. 21, 2019*
The initial release of Docspell containing the basic features with a
Web UI:
- Create items by uploading PDF files
- Analyze the PDF files and propose meta data
- Manage meta data and items
- View processing queue

View File

@ -2,6 +2,7 @@ import com.github.eikek.sbt.openapi._
import scala.sys.process._
import com.typesafe.sbt.SbtGit.GitKeys._
import docspell.build._
import microsites.ExtraMdFileConfig
val toolsPackage = taskKey[Seq[File]]("Package the scripts/extension tools")
val elmCompileMode = settingKey[ElmCompileMode]("How to compile elm sources")
@ -386,6 +387,13 @@ val microsite = project.in(file("modules/microsite")).
"VERSION" -> version.value,
"PVERSION" -> version.value.replace('.', '_')
),
micrositeExtraMdFiles := Map(
file("Changelog.md") -> ExtraMdFileConfig(
"changelog.md",
"docs",
Map("title" -> "Changelog", "permalink" -> "changelog")
)
),
Compile/resourceGenerators += Def.task {
val conf1 = (resourceDirectory in (restserver, Compile)).value / "reference.conf"
val conf2 = (resourceDirectory in (joex, Compile)).value / "reference.conf"

View File

@ -1,12 +1,12 @@
---
layout: docs
position: 4
title: Documentation
---
# {{page.title}}
This is the documentation for Docspell @VERSION@.
This is the documentation for Docspell @VERSION@. There is a
[changelog](changelog).
Docspell assists in organizing large amounts of PDF files that are
typically scanned paper documents. You can associate tags, set

View File

@ -1,7 +1,9 @@
#masthead {
background: url(../img/back-master-small.jpg);
background-repeat: no-repeat;
background-size: 100% 800px;
background-size: 100% 100%;
animation: none;
height: 25vh;
}
.thumbnail {
@ -9,7 +11,7 @@
}
.features-image {
max-height: 250px;
height: 200px;
}
.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open>a, .docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open button {