Releases: docat-org/docat
1.3.1 Crash less
What's Changed
- Allow configuration of MAX_UPLOAD_SIZE by @tbuerli-komax in #792
- Bugfix: Do not crash on broken zip by @fliiiix in #819
- chore: update python deps by @fliiiix in #819
- chore: update web deps by @fliiiix in #820
New Contributors
- @tbuerli-komax made their first contribution in #792
Full Changelog: 1.3.0...1.3.1
1.3.0: Share Modal
What's Changed
- Added docat/tests to .dockerignore by @pipilacha in #761
- Improvement/add prettier by @reglim in #775
- Feature: Add Share modal in place of Hide UI button by @reglim in #777
- Feat: Add not found page for iframe by @reglim in #782
- Fix: Remove copy button when copying is not supported by @reglim in #786
- Chore/update dependencies by @reglim in #780
New Contributors
- @pipilacha made their first contribution in #761
Full Changelog: 1.2.0...1.3.0
1.2.0: Version Footer ποΈ
What's Changed
- Fix: Optimize Docker build by @reglim in #640
- Feature: Add Version Tag to Footer by @reglim in #612
- Fix: Make pipeline include full history to fix tag in containers from CI by @reglim in #641
- Group dependabot updates by @randombenj in #647
Full Changelog: 1.1.1...1.2.0
1.1.1: Compatibility Fixes
What's Changed
Full Changelog: 1.1.0...1.1.1
1.1.0 Better Navigation
What's Changed
- Feature/maintanace by @fliiiix in #508
- Feature: Add warning if index.html is missing in uploaded archive by @reglim in #530
- Improvement/531-no-index-html-warning-in-UI by @reglim in #532
- fix: docatl tag command within README.md by @mweb in #533
- Fix nginx index option url routing by @fliiiix in #582
- fix/585-minor-ui-fixes by @reglim in #586
- Fix: Docs blinking when navigating between hashes or pages by @reglim in #587
- Improvement/589-migrate-to-vite-and-vitest by @reglim in #590
- Fix: Navigate Back not working on docs page, navigate forward is currently not possible by @reglim in #595
- Fix: Iframing allowed, restrict frame-ancestors to self by @reglim in #608
- Fix/docs-page-url-handling by @reglim in #598
8 UI & Backend dependencies updated
New Contributors
Full Changelog: 1.0.0...1.1.0
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
0.3.0 The big release
New fall release with quite a lot of changes:
- Better developer setup
- Upgraded dependencies
- Support for project Icons
- Improved display of long project names
- Fixes to the version selector
- Various other small bug fixes
Thanks everyone involved π
What's Changed
- Feat: add project api by @randombenj in #239
- Update teaser image by @randombenj in #240
- Feat(web) #74 Favoring projects by @galaplexus in #171
- Fix: remove unused dependency by @randombenj in #247
- Fix: broken layout by @randombenj in #252
- Fix latest version selection by @lukasweber in #257
- Fix(docat): Trailing Slash resulting in 404 status code by @reglim in #269
- Fix(docat): Upload of file with name of tag by @reglim in #272
- Feat(docat): Add Rename API by @reglim in #273
- Fix dropdown not showing version when selecting latests via URL by @Gerfatz in #265
- Feat(Docat): Add Api to upload project icon by @reglim in #275
- Fix project title not on same line as Logo by @reglim in #280
- chore: dependencies upgrade by @fliiiix in #281
- Bugfix/282-project-titles-look-bad by @reglim in #284
New Contributors
Full Changelog: 0.2.3...0.3.0
0.2.3 Long time no see π Part 2
Github Action never tagged the 0.2.2 release due to a bug in the setup.
For release notes see: https://github.com/docat-org/docat/releases/tag/0.2.2
What's Changed
Full Changelog: 0.2.2...0.2.3
0.2.2 Long time no see π
Not a lot has changed since the last release,
but there is quite a big list of small improvements.
And there are even more dependencies updates.
Thanks to all the contributors for this release β¨
What's Changed
- Fix docs page to redirect if no version in url by @lukasweber in #132
- fix(docker) specify strongly base image by @galaplexus in #136
- Fix order of document viewer route by @lukasweber in #159
- feat(ci): Run frontend test and lint with gh actions by @fliiiix in #168
- Fixing: Sorting of versions #142 by @fliiiix in #167
- Allow db.json to be persisted in a custom location by @zedalaye in #216
- style: improve upload UX by @BrunnerLivio in #223
- Bugfix/get docker up and running by @fliiiix in #230
- fix(github-action): run docker push only on main repo by @fliiiix in #232
- Bugfix remove unnecessary files by @fliiiix in #231
- Fix/error handling UX by @gianfurrer in #237
New Contributors
- @lukasweber made their first contribution in #132
- @zedalaye made their first contribution in #216
- @BrunnerLivio made their first contribution in #223
- @gianfurrer made their first contribution in #237
Full Changelog: 0.2.1...0.2.2
0.2.1 New design, who dis?
New design thanks to @randombenj we don't need a header to switch the versions,
now you just have a small floating button to change versions π
What's Changed
- feat: reduce weight of docat header by @randombenj in #129
- docs: Adapt URL in LICENSE file by @dev-jan in #131
- docs: Fix docker command in README to not throw error by @dev-jan in #130
New Contributors
Full Changelog: 0.2.0...0.2.1