Update microsite

Changelog.md

@@ -2,7 +2,7 @@
 
 ## v0.4.0 
 
-*unknown*
+*Mar. 29, 2020*
 
 - Support for archive files. Archives, for example zip files, contain
   the files that should go into docspell. Docspell now extracts

README.md

@@ -46,13 +46,13 @@ book and only once in a while it has to be revisited.
 
 ## Documentation
 
-The [documentation site](https://eikek.github.io/docspell/) provides
+The [documentation site](https://docspell.org) provides more
-more information.
+information.
 
 Check the feature list and the quickstart guide to try it out:
 
-- [Features](https://eikek.github.io/docspell/features.html)
+- [Features](https://docspell.org/features)
-- [Quickstart](https://eikek.github.io/docspell/getit)
+- [Quickstart](https://docspell.org/getit)
 
 
 ## Screenshots

build.sbt

@@ -383,8 +383,8 @@ val microsite = project.in(file("modules/microsite")).
     ),
     micrositeName := "Docspell",
     micrositeDescription := "Auto-tagging Document Organizer",
-    micrositeDocumentationUrl := "/getit",
+    micrositeDocumentationUrl := "doc",
-    micrositeDocumentationLabelDescription := "Quickstart",
+    micrositeDocumentationLabelDescription := "Documentation",
     micrositeFavicons := Seq(microsites.MicrositeFavicon("favicon.png", "96x96")),
     micrositeAuthor := "eikek",
     micrositeGithubOwner := "eikek",

modules/microsite/docs/api.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Api
+permalink: api
 ---
 
 # {{page.title}}

modules/microsite/docs/demo.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Demo
+permalink: demo
 ---
 
 # {{ page.title }}

modules/microsite/docs/dev.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Development
+permalink: dev
 ---
 
 
@@ -125,10 +126,3 @@ sets more memory for the vm):
 export QEMU_OPTS="-m 2048"
 ./result/bin/run-docspelltest-vm
 ```
-
-## ADRs
-
-Some early information about certain details can be found in the few
-[ADR](https://adr.github.io/) that exist:
-
-- [ADRs](dev/adr.html)

modules/microsite/docs/dev/adr.md

@@ -1,19 +1,23 @@
 ---
 layout: docs
 title: ADRs
+permalink: dev/adr
 ---
 
 # ADR
 
-- [0001 Components](adr/0001_components)
+Some early information about certain details can be found in a few
-- [0002 Component Interaction](adr/0002_component_interaction)
+[ADR](https://adr.github.io/) that exist:
-- [0003 Encryption](adr/0003_encryption)
+
-- [0004 ISO8601 vs Unix](adr/0004_iso8601vsEpoch)
+- [0001 Components](0001_components)
-- [0005 Job Executor](adr/0005_job-executor)
+- [0002 Component Interaction](0002_component_interaction)
-- [0006 More File Types](adr/0006_more-file-types)
+- [0003 Encryption](0003_encryption)
-  - [0007 Convert HTML](adr/0007_convert_html_files)
+- [0004 ISO8601 vs Unix](0004_iso8601vsEpoch)
-  - [0008 Convert Text](adr/0008_convert_plain_text)
+- [0005 Job Executor](0005_job-executor)
-  - [0009 Convert Office Files](adr/0009_convert_office_docs)
+- [0006 More File Types](0006_more-file-types)
-  - [0010 Convert Image Files](adr/0010_convert_image_files)
+  - [0007 Convert HTML](0007_convert_html_files)
-  - [0011 Extract Text](adr/0011_extract_text)
+  - [0008 Convert Text](0008_convert_plain_text)
-- [0012 Periodic Tasks](adr/0012_periodic_tasks)
+  - [0009 Convert Office Files](0009_convert_office_docs)
+  - [0010 Convert Image Files](0010_convert_image_files)
+  - [0011 Extract Text](0011_extract_text)
+- [0012 Periodic Tasks](0012_periodic_tasks)

modules/microsite/docs/dev/adr/0000_use_markdown_architectural_decision_records.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Use Markdown Architectural Decision Records
+permalink: dev/adr/0000
 ---
 
 # Use Markdown Architectural Decision Records

modules/microsite/docs/dev/adr/0001_components.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Components
+permalink: dev/adr/0001_components
 ---
 
 # Components

modules/microsite/docs/dev/adr/0002_component_interaction.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Component Interaction
+permalink: dev/adr/0002_component_interaction
 ---
 
 # Component Interaction

modules/microsite/docs/dev/adr/0003_encryption.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Encryption
+permalink: dev/adr/0003_encryption
 ---
 
 # Encryption

modules/microsite/docs/dev/adr/0004_iso8601vsEpoch.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: ISO8601 vs Millis
+permalink: dev/adr/0004_iso8601vsEpoch
 ---
 
 # ISO8601 vs Millis as Date-Time transfer

modules/microsite/docs/dev/adr/0005_job-executor.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Joex - Job Executor
+permalink: dev/adr/0005_job-executor
 ---
 
 # Job Executor

modules/microsite/docs/dev/adr/0006_more-file-types.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: More File Types
+permalink: dev/adr/0006_more-file-types
 ---
 
 # More File Types

modules/microsite/docs/dev/adr/0007_convert_html_files.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Convert HTML Files
+permalink: dev/adr/0007_convert_html_files
 ---
 
 # {{ page.title }}

modules/microsite/docs/dev/adr/0008_convert_plain_text.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Convert Text Files
+permalink: dev/adr/0008_convert_plain_text
 ---
 
 # {{ page.title }}

modules/microsite/docs/dev/adr/0009_convert_office_docs.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Convert Office Documents
+permalink: dev/adr/0009_convert_office_docs
 ---
 
 # {{ page.title }}

modules/microsite/docs/dev/adr/0010_convert_image_files.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Convert Image Files
+permalink: dev/adr/0010_convert_image_files
 ---
 
 # {{ page.title }}

modules/microsite/docs/dev/adr/0011_extract_text.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Extract Text from Files
+permalink: dev/adr/0011_extract_text
 ---
 
 # Extract Text from Files

modules/microsite/docs/dev/adr/0012_periodic_tasks.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Periodic Tasks
+permalink: dev/adr/0012_periodic_tasks
 ---
 
 # Periodic Tasks

modules/microsite/docs/dev/adr/0013_archive_files.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Archive Files
+permalink: dev/adr/0013_archive_files
 ---
 
 # {{ page.title }}

modules/microsite/docs/doc.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Documentation
+permalink: doc
 ---
 
 # {{page.title}}

modules/microsite/docs/doc/configure.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Configuring
+permalink: doc/configure
 ---
 
 # {{ page.title }}

modules/microsite/docs/doc/curate.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Find and Review
+permalink: doc/curate
 ---
 
 # {{page.title}}

modules/microsite/docs/doc/install.md

@@ -1,12 +1,13 @@
 ---
 layout: docs
 title: Installation
+permalink: doc/install
 ---
 
 # {{ page.title }}
 
 This page contains detailed installation instructions. For a quick
-start, refer to [this page](../getit.html).
+start, refer to [this page](../getit).
 
 Docspell has been developed and tested on a GNU/Linux system. It may
 run on Windows and MacOS machines, too (ghostscript and tesseract are
@@ -29,7 +30,7 @@ While this is possible, the simple setup is to start both components
 once on the same machine.
 
 The [download page](https://github.com/eikek/docspell/releases)
-provides pre-compiled packages and the [development page](dev.html)
+provides pre-compiled packages and the [development page](../dev)
 contains build instructions.
 
 
@@ -112,7 +113,7 @@ When using H2, make sure that all components access the same database
 – the jdbc url must point to the same file. Then, it is important to
 add the options
 `;MODE=PostgreSQL;DATABASE_TO_LOWER=TRUE;AUTO_SERVER=TRUE` at the end
-of the url. See the [default config](configure.html) for an example.
+of the url. See the [config page](configure#jdbc) for an example.
 
 
 ## Installing from ZIP files
@@ -149,9 +150,9 @@ $ ./docspell-joex*/bin/docspell-joex
 This will startup both components using the default configuration. The
 configuration should be adopted to your needs. For example, the
 database connection is configured to use a H2 database in the `/tmp`
-directory. Please refer to the [configuration page](configure.html)
+directory. Please refer to the [configuration page](configure) for how
-for how to create a custom config file. Once you have your config
+to create a custom config file. Once you have your config file, simply
-file, simply pass it as argument to the command:
+pass it as argument to the command:
 
 ```
 $ ./docspell-restserver*/bin/docspell-restserver /path/to/server-config.conf
@@ -163,7 +164,7 @@ path `/app`, so using default values it would be
 `http://localhost:7880/app`.
 
 You should be able to create a new account and sign in. Check the
-[configuration page](configure.html) to further customize docspell.
+[configuration page](configure) to further customize docspell.
 
 
 ### Options

modules/microsite/docs/doc/joex.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Joex
+permalink: doc/joex
 ---
 
 # {{ page.title }}
@@ -17,7 +18,7 @@ parallel is limited with respect to the hardware it is running on.
 For larger installations, it is probably better to run several joex
 components on different machines. That works out of the box, as long
 as all components point to the same database and use different
-`app-id`s (see [configuring docspell](./configure.html)).
+`app-id`s (see [configuring docspell](./configure#app-id)).
 
 When files are submitted to docspell, they are stored in the database
 and all known joex components are notified about new work. Then they
@@ -50,10 +51,10 @@ next. The default is `4, 1`, meaning to first select 4 high priority
 jobs and then 1 low priority job, then starting over. If no such job
 exists, its falls back to the other priority.
 
-The priority can be set on a *Source* (see
+The priority can be set on a *Source* (see [uploads](uploading)).
-[uploads](uploading.html)). Uploading through the web application will
+Uploading through the web application will always use priority *high*.
-always use priority *high*. The idea is that while logged in, jobs are
+The idea is that while logged in, jobs are more important that those
-more important that those submitted when not logged in.
+submitted when not logged in.
 
 
 ## Scheduler Config

modules/microsite/docs/doc/mailitem.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Send items via E-Mail
+permalink: doc/mailitem
 ---
 
 # {{page.title}}

modules/microsite/docs/doc/metadata.md

@@ -1,21 +1,26 @@
 ---
 layout: docs
 title: Adding Meta Data
+permalink: doc/metadata
 ---
 
 # {{ page.title }}
 
 ## Meta Data
 
-The processing can be controlled implicitely by the provided meta
+Docspell processes each uploaded file. Processing involves extracting
-data. The *Meta Data* page allows to manage this meta data. You can
+archives, extracting text, anlyzing the extracted text and converting
-create the following:
+the file into a pdf. Text is analyzed to find metadata that can be set
+automatically. Docspell compares the extracted text against a set of
+known meta data. The *Meta Data* page allows to manage this meta data.
+You can create the following:
 
 - Tags
 - Organizations
 - Persons
 - Equipments
 
+
 ### Tags
 
 Items can be tagged with multiple custom tags (aka labels). This
@@ -32,7 +37,7 @@ can help to implement some.
 
 The tags are *not* taken into account when processing. Docspell will
 not automatically associate tags to your items. The tags are only
-meant to be used manually.
+meant to be used manually for now.
 
 
 ### Organization and Person

modules/microsite/docs/doc/processing.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Processing Queue
+permalink: doc/processing
 ---
 
 # {{ page.title }}

modules/microsite/docs/doc/tools.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Tools
+permalink: doc/tools
 ---
 
 # {{ page.title }}
@@ -65,7 +66,7 @@ ExecStart=/bin/su -s /bin/bash someuser -c "consumedir.sh --path '/a/path/' -m '
 This unit file is just an example, it needs some fiddling. It assumes
 an existing user `someuser` that is used to run this service. The url
 `http://localhost:7880/api/v1/open/upload/...` is an anonymous upload
-url as described [here](./uploading.html).
+url as described [here](./uploading#anonymous-upload).
 
 
 ## ds.sh
@@ -88,7 +89,7 @@ url.2 = http://localhost:7880/api/v1/open/upload/item/6DxhjkvWf9S-CkWqF3Kr892-Wg
 ```
 
 The key must start with `url`. The urls should be [anonymous upload
-urls](./uploading.html).
+urls](./uploading#anonymous-upload).
 
 
 ### Usage

modules/microsite/docs/doc/uploading.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Uploads
+permalink: doc/uploading
 ---
 
 # {{page.title}}

modules/microsite/docs/features.md

@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Features and Limitations
+permalink: features
 ---
 
 # Features

modules/microsite/docs/getit.md

@@ -1,7 +1,7 @@
 ---
 layout: docs
 title: Quickstart
-permalink: getit/
+permalink: getit
 ---
 
 ## {{ page.title }}
@@ -56,4 +56,4 @@ PDF conversion requires the following tools:
 5. Register a new account, sign in and try it.
 
 Check the [early demo video](demo) to see the basic idea. Refer to the
-[documentation](doc.html) for more information on how to use docspell.
+[documentation](doc) for more information on how to use docspell.

modules/microsite/docs/index.md

@@ -1,9 +1,9 @@
 ---
 layout: homeFeatures
 features:
- - first: ["Stow documents away", "Most of the time documents (emails, postal mail) are received or created. It should be fast to stow them away, knowing that they can be found if necessary."]
+ - first: ["Stow documents away", "Most of the time documents (emails, postal mail) are received or created. It should be fast to stow them away, knowing that they can be found if necessary.", "uploading"]
- - second: ["Automatic Tagging", "All documents are analyzed and tagged automatically. It may not always be correct; results can be reviewed and corrected."]
+ - second: ["Automatic Tagging", "All documents are analyzed and tagged automatically. It may not always be correct; results can be reviewed and corrected.", "metadata"]
- - third: ["Work with them", "Search for documents by their meta data. Send them via e-mail. Add your own tags, names etc to better match your workflow."]
+ - third: ["Work with them", "Search for documents by their meta data. Send them via e-mail. Add your own tags, names etc to better match your workflow.", "curate"]
 ---
 
 

modules/microsite/src/main/resources/microsite/css/docspell.css

@@ -1,6 +1,5 @@
 #site-main {
-    background: floralwhite;
+    background: aliceblue;
-    padding: 40px 0;
 }
 
 #masthead {
@@ -8,7 +7,7 @@
     background-repeat: no-repeat;
     background-size: 100% 100%;
     animation: none;
-    height: 25vh;
+    height: 26vh;
 }
 
 .thumbnail {
@@ -17,6 +16,7 @@
 
 .features-image {
     height: 200px;
+    position: relative;
 }
 
 .docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open>a, .docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open button {

modules/microsite/src/main/resources/microsite/data/menu.yml

@@ -3,23 +3,23 @@ options:
     url: index.html
 
   - title: Demo
-    url: demo.html
+    url: demo
 
   - title: Quickstart
     url: getit
 
   - title: Features/Limitations
-    url: features.html
+    url: features
 
   - title: Documentation
-    url: doc.html
+    url: doc
 
     nested_options:
      - title: Installation
-       url: doc/install.html
+       url: doc/install
 
      - title: Configuring
-       url: doc/configure.html
+       url: doc/configure
 
      - title: Nix/NixOS
        url: doc/nix
@@ -28,35 +28,35 @@ options:
        url: doc/reverseproxy
 
      - title: Adding Meta Data
-       url: doc/metadata.html
+       url: doc/metadata
 
      - title: Uploads
-       url: doc/uploading.html
+       url: doc/uploading
 
      - title: Processing Queue
-       url: doc/processing.html
+       url: doc/processing
 
      - title: Find and Review
-       url: doc/curate.html
+       url: doc/curate
 
      - title: Send via E-Mail
-       url: doc/mailitem.html
+       url: doc/mailitem
 
      - title: Joex
-       url: doc/joex.html
+       url: doc/joex
 
      - title: Tools
-       url: doc/tools.html
+       url: doc/tools
 
   - title: Development
-    url: dev.html
+    url: dev
 
     nested_options:
-      - tite: ADRs
+      - title: ADRs
-        url: dev/adr.html
+        url: dev/adr
 
   - title: Api
-    url: api.html
+    url: api
 
     nested_options:
      - title: REST Api Doc

modules/webapp/src/main/elm/App/View.elm

@@ -254,9 +254,9 @@ loginInfo model =
                         , div [ class "divider" ] []
                         , a
                             [ class "icon item"
-                            , href "https://eikek.github.io/docspell/doc"
+                            , href "https://docspell.org/doc"
                             , target "_new"
-                            , title "Opens https://eikek.github.io/docspell/doc"
+                            , title "Opens https://docspell.org/doc"
                             ]
                             [ i [ class "help icon" ] []
                             , text "Help"

tools/webextension/README.md

@@ -5,6 +5,6 @@ downloaded in the context of your current page. Then handed to an
 application that finally pushes it to docspell.
 
 Please see the
-[microsite](https://eikek.github.io/docspell/doc/tools.html) for
+[microsite](https://docspell.org/doc/tools) for
 instructions or navigate to the corresponding [markdown
 file](../../modules/microsite/src/main/tut/doc/tools.md#webextension-for-docspell).