[MDEV-28701] Update server HELP contents Created: 2022-05-31  Updated: 2023-01-24  Resolved: 2023-01-24

Status: Closed
Project: MariaDB Server
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 10.3.38, 10.4.28, 10.5.19, 10.6.12, 10.7.8, 10.8.7, 10.9.5

Type: Bug Priority: Major
Reporter: Ian Gilfillan Assignee: Ian Gilfillan
Resolution: Fixed Votes: 0
Labels: None

Issue Links:
PartOf
includes MDEV-27399 Missing help items Open
includes MDEV-29286 HELP && does not work in current vers... Closed
Relates
relates to MDBF-341 Create downloadable pdf version of th... Closed
relates to MDEV-6521 HELP Contents need to use MariaDB Kno... Closed
relates to MDEV-29641 Help topics say SUPER is required to ... Open

 Description   

The server HELP contents have stalled since MDEV-6521. This task is to maintain them and integrate them into the work done for MDBF-341, so that the same spreadsheet can be used to generate content for the PDF as well as the HELP.

The current process is still too manual. The following changes should be implemented:

  • New column, HELP Keywords - a semicolon delimited list of keywords
  • HELP Cat takes a text value (the name of the category), rather than a numeric value

The script will:

  • Be passed a version value, e.g. 105, when run.
  • Loop through the csv, looking at the HELP Include field
    • 1 - include in all cases
    • 0 - exclude in all cases
    • 10x - e.g. 105. Include when the version being generated is 10.x or above
    • Report all rows that have no HELP Include value
    • Generate the SQL for the help_topic, help_keyword and help_relation tables from the supplied information.
    • For help_category, spreadsheet containing categories, parents, will be used to generate the sql for all versions

Generated at Thu Feb 08 10:02:49 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.