bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Finished up v0.29 blogpost

Browse source
This commit is contained in:
Dan Brown 2020-04-13 16:08:52 +01:00
commit ed10fb6606
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
3 changed files with 87 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

95
content/blog/beta-release-v0-29-0.md
View file

@ -2,7 +2,7 @@
categories = ["Releases"]
tags = ["Releases"]
title = "Beta Release v0.29.0"
date = 2020-04-12T22:00:00Z
date = 2020-04-13T15:30:00Z
author = "Dan Brown"
image = "/images/blog-cover-images/easter-victor-larracuente.jpg"
description = "This Easter BookStack release focuses on bringing a range user-experience improvements, with features such as dark mode and improved RTL textsupport, in addition to a bunch of fixes and enhancements."
@ -10,8 +10,8 @@ slug = "beta-release-v0-29-0"
draft = false
+++
This Easter BookStack release focuses on bringing a range user-experience improvements, with
features such as dark mode and improved RTL text support, in addition to a bunch
This Easter BookStack release welcomes a range of user-experience improvements, with
features such as dark mode and improved right-to-left text support, in addition to a bunch
of fixes and enhancements.
* [Update instructions](https://www.bookstackapp.com/docs/admin/updates)
@ -20,14 +20,16 @@ of fixes and enhancements.
### Dark Mode
BookStack now has a built-in dark mode:
BookStack now has a built-in dark mode. Here's a comparison of the same content shown in both dark and light mode:
[![Dark Mode](/images/2020/04/bookstack-dark-mode.png)](/images/2020/04/bookstack-dark-mode.png)
[Click to open larger view](/images/2020/04/bookstack-dark-mode.png).
The dark mode covers all areas of the system including both the WYSIWYG and markdown editors.
Where possible, page content such as tables and code blocks will react and change to be suitable dark alternatives.
Where possible, page content such as tables & code blocks will react and change to be suitable dark alternatives.
Vibrant theme-color elements, such as the header bar, will be automatically dimmed and de-saturated
as to not stand-out or be overly-bright on an otherwise dark page.
so they don't stand-out or remain overly-bright on an otherwise dark page.
The option is user-selectable, from either the home-screen on via the top-right profile menu:
@ -43,11 +45,11 @@ community with a well-supported dark theme for the last few years.
### Custom Draw.io Option
Previously in BookStack the URL for draw.io, [now diagrams.net](https://www.diagrams.net/blog/move-diagrams-net),
was hard-coded within the BookStack code. This has now been exposed and can be customized as an `.env` option
meaning you can tweak the embed behaviour or even use your own self-hosted draw.io instance.
Previously in BookStack the URL for draw.io ([now diagrams.net](https://www.diagrams.net/blog/move-diagrams-net))
was hard-coded within the BookStack code. This has now been exposed and can be customised as an `.env` option
meaning you can tweak the embed behaviour or even use your own [self-hosted draw.io instance](https://github.com/jgraph/drawio).
[Details for using this option can be found here](/docs/admin/other-config/#custom-drawio-url)
[Details for using this option can be found here](/docs/admin/other-config/#custom-drawio-url).
### Shelf Grid View
@ -56,13 +58,13 @@ for the books within:
![Shelf Grid View](/images/2020/04/bookstack-shelf-grid.png)
This aligns the shelf page with the view options selectable on the "Books" page.
This aligns the shelf page with the view options available on the "Books" page.
A big thanks to [@philjak](https://github.com/BookStackApp/BookStack/pull/1755) for contributing
this feature.
### List of Shelves for Books
Previously in BookStack it was not easy to see what shelves a book is assigned to.
Previously in BookStack it was not easy to see the shelves a book is assigned to.
In this release, A list of assigned shelves can now be seen when viewing a book:
![Book shelves list](/images/2020/04/bookstack-book-shelves-list.png)
@ -73,22 +75,79 @@ this feature to BookStack.
### API Updates
The API has been expanded upon with the ability to perform CRUD operations on shelves in the system.
In addition, books have recieved endpoints for exporting their contents as HTML, PDF or PlainText.
You'll be able to find details of these when accessing the API docs in your instance, after updating.
The API has been expanded upon with the ability to perform CRUD operations on shelves.
In addition, books have received endpoints for exporting their contents as HTML, PDF or plain-text.
You'll be able to find details of these when accessing the [API docs in your instance](/docs/admin/hacking-bookstack/#bookstack-api), after updating.
![API Endpoint Updates](/images/2020/04/bookstack-api-endpoints.png)
### Instance URL Update Command
Since BookStack hard-codes system URL's in the database, a change in the domain
used for your instance meant that some manual SQL commands needed to be ran to
update the domain in the relevant tables & columns. In this release a command
has been added to make this much quicker & easier, You just run the command providing
your old and new URL and all the required columns will be updated.
Here's and example of running this command:
```bash
$ php artisan bookstack:update-url http://bookstack.local https://my-docs.com
This will search for "http://bookstack.local" in your database and replace it with "https://my-docs.com".
Are you sure you want to proceed? (yes/no) [no]:
> yes
This operation could cause issues if used incorrectly. Have you made a backup of your existing database? (yes/no) [no]:
> yes
Updated 0 rows in attachments->path
Updated 26 rows in pages->html
Updated 0 rows in pages->text
Updated 8 rows in pages->markdown
Updated 394 rows in images->url
Updated 0 rows in comments->html
Updated 0 rows in comments->text
URL update procedure complete.
```
The command has been added to the [command documentation found here](/docs/admin/commands/).
### Improved RTL System UI Support
For this release the core styles have been revised to work better for right-to-left (RTL) languages:
![RTL Styling](/images/2020/04/bookstack-rtl.png)
Previously the BookStack UI would remain left-to-right (LTR), even when a RTL language was in use.
Setting the html to display as RTL would cause most of the views to break as the styles were defined with LTR
in mind.
For v0.29, we've made heavy use of [CSS logical properties and values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties)
to ensure our styles work as expected when showing in an RTL format. Although, as of writing, [the spec for logical properties is in draft](https://drafts.csswg.org/css-logical/) it is well supported amongst the modern browsers we support, albeit with a [few omissions](https://bugs.chromium.org/p/chromium/issues/detail?id=1050751).
### Translations
Our fantastic community of translators continue to provide their great efforts as this release brings updates
from the below languages by the below great Crowdin & GitHub members:
* Hasan Özbey (the-turk) - *Turkish*
* mrjaboozy - *Slovenian*
* rcy - *Swedish*
* Ali Yasir Yılmaz (ayyilmaz) - *Turkish*
* m0uch0 - *Spanish*
* scureza - *Italian*
* Statium - *Russian*
* Biepa - *German Informal; German*
* Finn Wessel (19finnwessel6) - *German*
* nutsflag - *French*
* syecu - *Chinese Simplified*
* Rodrigo Saczuk Niz (rodrigoniz) - *Portuguese, Brazilian*
* Lap1t0r - *French*
* Thinkverse (thinkverse) - *Swedish*
* milesteg - *Hungarian*
* [@jzoy](https://github.com/BookStackApp/BookStack/pull/2023) - *Chinese*
### Full List of Changes
@ -109,14 +168,14 @@ You'll be able to find details of these when accessing the API docs in your inst
* Updated Chinese translations. Thanks to [@jzoy](https://github.com/BookStackApp/BookStack/pull/2023). ([#2023](https://github.com/BookStackApp/BookStack/pull/2023))
* Updated default .htaccess to allow Authorization header for API usage. Thanks to [@osmansorkar](https://github.com/BookStackApp/BookStack/pull/1908). ([#1908](https://github.com/BookStackApp/BookStack/pull/1908))
* Updated GitHub authorization library to avoid use of deprecated auth methods. ([#1879](https://github.com/BookStackApp/BookStack/issues/1879))
* Fixed issue where ordered list numbers could be cut-off. This was most apparant on Safari.([#1978](https://github.com/BookStackApp/BookStack/issues/1978))
* Fixed issue where ordered list numbers could be cut-off. This was most apparent on Safari.([#1978](https://github.com/BookStackApp/BookStack/issues/1978))
### Next Steps
For the next release I'll look to continue to add to the API endpoints. Would be nice to get the core chapter & page actions done.
For the next release I'll look to continue expanding the range of API endpoints. Would be nice to get the core chapter & page actions done.
As per my "v0.28 next steps", I'll look to align how activity is tracked. The first steps will likely be to expand the range of
tracked actions then expose everything within the admin area in a filterable interface.
tracked actions then expose everything within the admin area in a filterable "Audit Trail".
----

7
content/docs/admin/commands.md
View file

@ -47,4 +47,11 @@ php artisan bookstack:delete-users
# Copy the permission settings of a specified, or all, shelf to their child books
php artisan bookstack:copy-shelf-permissions --all
php artisan bookstack:copy-shelf-permissions --slug=my_shelf_slug
# Update a URL in the database content of your BookStack instance.
# Searches for <oldUrl> and replaces it with <newUrl>
php artisan bookstack:update-url <oldUrl> <newUrl>
# Example:
php artisan bookstack:update-url http://docs.example.com https://demo.bookstackapp.com
```

BIN
static/images/2020/04/bookstack-rtl.png (Stored with Git LFS) Normal file
View file

Binary file not shown.