Docat is finished

Changes

• Migrate Docat-Web from Vue2 to React
• Improve general appearance
• Add a new "Hide Ui" button, that hides the possibility to change versions
• Add possibility to hide / show versions in drop-down
• Add fuzzy search to docat-web
• Display current latest tag next to projects
• Display banner if user is not on latest documentation version

Breaking Changes

Version priority change

If any of your versions is called latest, it will now automatically be used as your latest version.
Latest tags will still have precedence over the latest semantic version however.

/api/projects endpoint

The response model for /api/projects has changed and now includes more data like whether a logo exists and the versions of the project.

NGINX config

If you use a custom nginx config (for example for SSL Keys), you need to make sure your config has the following line where location / is used:

location / {
    try_files $uri /index.html;
}

db.json and DOCAT_DOC_PATH

The DOCAT_STORAGE_PATH environment variable is no longer used.
Instead, we rely on DOCAT_DOC_PATH, which now contains both the documents folder and the database, so now it is possible to run docat while only having to mount a single directory.

If you mount your database separately, or used DOCAT_STORAGE_PATH in the past be sure to change your setup so you have:

• Top level folder (for example /var/docat), this will be your DOCAT_DOC_PATH
• A nested documents folder (eg. /var/docat/doc), which previously was DOCAT_STORAGE_PATH
• Your database should then be located inside of DOCAT_DOC_PATH (here this would be /var/docat/db.json)

With this setup, you can then mount your DOCAT_DOC_PATH into your docker container.

More information can also be found at #320 .

Detailed Changes

• feat(web): use a more neutral color (fixes #285) by @randombenj in #287
• Fix(docat): Icon-Upload Mime Type Check by @reglim in #290
• Fix(web): Upload Document twice doesn't work by @reglim in #293
• Fix(web): Claim Token Selection Broken by @reglim in #291
• Docs: Document in UI and Docs that Claiming only works once by @reglim in #296
• Fix(web): Help Page shown before projects are loaded by @reglim in #295
• Fix(web): Tooltips vulnerable to XSS by @reglim in #300
• Feat/123-hide-version-dropdown-option by @reglim in #304
• Bugfix/fix docker image by @fliiiix in #305
• Docs: Reword getting-started.md by @reglim in #303
• Docs: Add Documentation on hide ui by @reglim in #317
• Fix(web): Project Select broken on delete page by @reglim in #315
• Docs: Add docatl command examples as alternatives to curl by @reglim in #316
• Feat(docat): Add API to hide project versions by @reglim in #321
• feat/13-implement-search by @reglim in #320
• Migrate to react by @reglim in #351
• Fix: Make sure every TinyDB index db instance is closed by @reglim in #370
• Improvement: Integrate the number of versions into projects endpoint by @reglim in #365
• Improvement: Integrate logo into projects endpoint by @reglim in #376
• Improvement: Add Index File switching by @reglim in #391
• Improvement: Integrate Versions into Projects API by @reglim in #384
• Fix docker build due to outdated poetry version by @randombenj in #394
• Chore/393-fix-has-unmet-peer-dependency by @reglim in #401
• chore: update dependencies fixing mypy issue by @fliiiix in #439
• Improvement: Remove Full-Text Search by @reglim in #446
• Improvement: Fix Search Result overflow by @reglim in #444
• Improvement/462-initial-page-load-speed by @reglim in #469
• Improvement: Remove Lint and Test from docker build by @reglim in #481
• Remove border radius for version select by @randombenj in #482
• Display latest version in project card by @randombenj in #483
• Fix: Links to Docs page didn't work by @reglim in #473
• Feature: Add Info banner if user is not on latest version by @reglim in #494
• Improvement: Migrate Search Results from seperate page to home page by @reglim in #493

Full Changelog: 0.3.0...1.0.0