[MDEV-6881] MariaDB Documentation improvements Created: 2014-10-16 Updated: 2019-06-05 Resolved: 2019-01-03 |
|
| Status: | Closed |
| Project: | MariaDB Server |
| Component/s: | OTHER |
| Fix Version/s: | N/A |
| Type: | Task | Priority: | Major |
| Reporter: | Stoykov (Inactive) | Assignee: | Bryan Alsdorf |
| Resolution: | Won't Do | Votes: | 2 |
| Labels: | Documentation | ||
| Issue Links: |
|
|||||||||||||||||||||||||||||||||||
| Sub-Tasks: |
|
|||||||||||||||||||||||||||||||||||
| Description |
|
MariaDB Documentation has search already. But MariaDB Documentation is missing downloadable /PDF, EPUB/ versions, there are some wrong or misleading descriptions. Example for wrong CREATE TRIGGER at https://mariadb.com/kb/en/sql-99-complete-really/24-sql-triggers/create-trigger-statement/
in the information bellow :
Next:
There are some other issues to be added, but it might be better to separate them in subtasks ? |
| Comments |
| Comment by Ian Gilfillan [ 2014-11-09 ] |
|
1) missing search. I'm not sure what you mean by this unless you missed the search icon (the magnifying glass). The search bar used to be visible before the redesign, now the icon must be clicked, but the search functionality still exists. 2) Documentation not available in a downloadable format. Agree, this feature has been requested before and would be useful, but I don't think is in the pipeline at the moment. 3) Triggers: FOR EACH ... STATEMENT. This is text from the SQL-99 book and I believe is correct. MariaDB does not support this, but the text states that it refers to the SQL standard, and not specifically MariaDB. 4) Missing ALL_O_DIRECT. Thanks, I will add this. Feel free to report other mistakes and omissions, preferably as separate tasks unless they're directly related. |
| Comment by Stoykov (Inactive) [ 2014-12-04 ] |
| Comment by Ian Gilfillan [ 2015-01-12 ] |
|
Unassigning from me, as the only outstanding issue is the downloadable version |
| Comment by Ian Gilfillan [ 2015-01-19 ] |
|
See also https://mariadb.com/kb/en/meta/mirroring-the-knowledge-base/ which describes a way to get an offline version. |
| Comment by Bryan Alsdorf [ 2015-01-21 ] |
|
Downloadable version is on my TODO but no ETA at this point unfortunately. Will update when I have a better idea. |
| Comment by Bryan Alsdorf [ 2019-01-03 ] |
|
We are in the process of overhauling documentation and will address this then. |
| Comment by Nuno [ 2019-06-05 ] |
|
MySQL allows us to download an HTML version of the knowledge base: https://dev.mysql.com/doc/ -> HTML Download (Zip) - 10.6Mb PHP allows the same: https://www.php.net/download-docs.php I understand MariaDB has a static copy of the KB, https://mariadb.com/kb/en/meta/mirroring-the-mariadb-knowledge-base/ Could we have all that static mirror downloadable in a zip file? Thank you! |