screenshot-1.png
[MXS-4687] MaxScale pages ambiguously titled when imported to the KB Created: 2023-07-31 Updated: 2023-10-30 |
|
| Status: | Stalled |
| Project: | MariaDB MaxScale |
| Component/s: | Documentation |
| Affects Version/s: | N/A |
| Fix Version/s: | N/A |
| Type: | Bug | Priority: | Major |
| Reporter: | Ian Gilfillan | Assignee: | Bryan Alsdorf |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Attachments: |
screenshot-1.png
|
| Description |
|
When new MaxScale releases are imported to the KB, pages are not titled correctly. For example, there's a page called "Upgrading". In fact, there will be multiple pages called "Upgrading" if no cleaning up was done. A user searching for "upgrading", looking to upgrade MariaDB Server, will be presented multiple links which appear to give them the answer they're looking for, but are about MaxScale, and they will frustratingly only see this after clicking through each link. Even people searching for MaxScale instructions will get multiple unhelpful results, to old releases. Even in cases where titles are obviously MaxScale-related, users will still find multiple identically-titled pages. The ideal way to fix this is to ensure the pages include MaxScale, and the version, in the title, for example as has been manually added to pages listed at https://mariadb.com/kb/en/mariadb-maxscale-25/ |
| Comments |
| Comment by markus makela [ 2023-07-31 ] |
|
bryan do you think this is something you can fix on your end? |
| Comment by Johan Wikman [ 2023-08-01 ] |
|
I'm not sure I understand the problem. When I searched for "Upgrading" in KB, I was presented with The context of each link seems to be clear? |
| Comment by Bryan Alsdorf [ 2023-08-02 ] |
|
johan.wikmanI believe Ian manually updated the title to make it clear. markus makela, if the ask is just to prefix "MaxScale $version" before the title of each page on import, yes I think that can be done fairly easily. |
| Comment by Bryan Alsdorf [ 2023-09-19 ] |
|
I've just deployed a fix for this. There is a new field in the KB admin called "Page Prefix". When populated, this string will be prefixed to any new page / category names. This will not impact already created pages / categories (in case they have manually been adjusted) so this will be most noticeable on the next major release of MaxScale. |
| Comment by Ian Gilfillan [ 2023-10-30 ] |
|
This does not appear to be working, see https://mariadb.com/kb/en/mariadb-maxscale-23-08/ |
| Comment by Bryan Alsdorf [ 2023-10-30 ] |
|
Looks to have worked for the release notes: https://mariadb.com/kb/en/mariadb-maxscale-2308-maxscale-2308-mariadb-maxscale-23082-release-notes-2023-10-30/+history This only applies to newly created pages |
