[MDEV-32900] Create page for each error message Created: 2023-11-28  Updated: 2024-01-10

Status: Open
Project: MariaDB Server
Component/s: Documentation
Fix Version/s: N/A

Type: Task Priority: Critical
Reporter: Ian Gilfillan Assignee: Ian Gilfillan
Resolution: Unresolved Votes: 0
Labels: None


 Description   

Each error code should have its own page, with details and links to ways to overcome it



 Comments   
Comment by Sergei Golubchik [ 2023-11-28 ]

what would be a url for such an error code page?

Comment by Ian Gilfillan [ 2023-11-29 ]

serg Something like https://mariadb.com/kb/en/ER_SP_BADSELECT seems the clearest and easiest to find. What do you think?

Comment by Sergei Golubchik [ 2023-11-29 ]

as short as possible and with an error number. Like https://mariadb.com/kb/en/e1312

Because the user will see

ERROR 1312 PROCEDURE foo can't return a result set in the given context

how can they know that it's ER_SP_BADSELECT ? It's 1312.

Comment by Ian Gilfillan [ 2024-01-09 ]

Any suggestions to improve https://mariadb.com/kb/en/e1006/ before I roll out more? It's a skeleton, so the explanation can be expanded, but in particular the URL, page title, excerpt (visible on https://mariadb.com/kb/en/error-codes/) and basic structure?

Comment by Ralf Gebhardt [ 2024-01-09 ]

Could we have an URL with the error a redirect to the same page with an URL using the error code?

The page could include some history about when an error code was added. Like ER_STORAGE_ENGINE_DISABLED , which was added only with 10.6. To not need to maintain this content manually an idea could be to get such details from the release notes, somehow like done for CVEs

Will the table https://mariadb.com/kb/en/mariadb-error-code-reference/ be built from these pages that the content only needs to be maintained on one page?

Comment by Ian Gilfillan [ 2024-01-09 ]

When you say "URL with the error", can you give a specific example?

Currently there's https://mariadb.com/kb/en/e1006/, which I think is easiest as it just uses the error number, and https://mariadb.com/kb/en/error-1006-cant-create-database/ (generated from the title).

Regarding building https://mariadb.com/kb/en/mariadb-error-code-reference/ from these pages, it's more the other way round, as the individual pages should be automatically generated, and then populated with more details, examples, ways to overcome etc.

Comment by Sergei Golubchik [ 2024-01-09 ]

And now with a 2-line change I have

MariaDB [test]> select (select 1 union select 2);
ERROR 1242 (21000): Subquery returns more than 1 row
More information:  https://mariadb.com/kb/en/e1242/
 
MariaDB [test]> select foo;
ERROR 1054 (42S22): Unknown column 'foo' in 'field list'
More information:  https://mariadb.com/kb/en/e1054/

Comment by Ralf Gebhardt [ 2024-01-10 ]

When you say "URL with the error", can you give a specific example?

Currently there's https://mariadb.com/kb/en/e1006/, which I think is easiest as it just uses the error number, and https://mariadb.com/kb/en/error-1006-cant-create-database/ (generated from the title).

With "URL with the error" I meant https://mariadb.com/kb/en/ER_CANT_CREATE_DB. But after some checks I see that ER_CANT_CREATE_DB more or less never. would be shown to a user. That said, I think that https://mariadb.com/kb/en/e1006/ should be good enough. the generated URL https://mariadb.com/kb/en/error-1006-cant-create-database/ only would add some value to me if it would be the URL displayed in the browser. But key will be to find the page easily (google search) and to have a short URL which can be added to tools (like Serg did - "nice") or server log. Nobody will guess the URL to find the error code description.

Regarding building https://mariadb.com/kb/en/mariadb-error-code-reference/ from these pages, it's more the other way round, as the individual pages should be automatically generated, and then populated with more details, examples, ways to overcome etc.

So if I understand correctly you would generate error pages from https://mariadb.com/kb/en/mariadb-error-code-reference/, which you edit manually, correct? I thought about getting the error codes from the source, therefore my comment about an automated creation of https://mariadb.com/kb/en/mariadb-error-code-reference/

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