I want to find the page "The xtrabackup option reference", which is our documentation showing all parameters accepted by the xtrabackup binary. In the 2.4 documentation, you could go to: "References -> The xtrabackup option reference", which is pretty intuitive, as you want the reference of all the parameters.
I needed the 8.0 version of this page, but if you change the Percona Xtrabackup version from 2.4 to 8.0 on the dropdown menu at the top of the page, you get redirected to the home of the Xtrabackup 8.0 documentation (it would be nice if I got redirected automatically to the same documentation in the new version, but that is not the issue I'm reporting here). Looking for the page by navigating the indexes, I noticed this page is no longer under "Reference". Here is where the page can be found: "Features -> Tools -> The xtrabackup binary -> The xtrabackup option reference".
It seems unintuitive that the parameters accepted by xtrabackup are listed under "Features". The documentation page is "Percona Xtrabackup - Documentation", which means we consider the xtrabackup binary to be a tool of Percona Xtrabackup, and having that binary is a feature of Percona Xtrabackup, which is confusing to me.
Ideally, it should be easy to find a documentation page by following the indexed entries, but even though I knew the exact page (and page name) I was looking for, I had to expand almost all of the options before finding it. This difficulty would be the same for every binary's option reference (xtrabackup, xbcloud, xbcrypt, xbstream). I'm opening this case to request reconsidering the indexing on PXB. If reverting back to the 2.4 structure is not an option, I'd propose making "Tools" a root entry in the index (and perhaps renaming it to "Binaries"). That would also be very intuitive if one is looking for the parameters accepted by any of the Percona Xtrabackup binaries/tools.
Environment
None
Activity
Show:
patrick.birch July 13, 2023 at 4:54 PM
I'd propose making "Tools" a root entry in the index (and perhaps renaming it to "Binaries"). That would also be very intuitive if one looks for the parameters accepted by any of the Percona XtraBackup binaries/tools.
I want to find the page "The xtrabackup option reference", which is our documentation showing all parameters accepted by the xtrabackup binary. In the 2.4 documentation, you could go to: "References -> The xtrabackup option reference", which is pretty intuitive, as you want the reference of all the parameters.
I needed the 8.0 version of this page, but if you change the Percona Xtrabackup version from 2.4 to 8.0 on the dropdown menu at the top of the page, you get redirected to the home of the Xtrabackup 8.0 documentation (it would be nice if I got redirected automatically to the same documentation in the new version, but that is not the issue I'm reporting here). Looking for the page by navigating the indexes, I noticed this page is no longer under "Reference". Here is where the page can be found: "Features -> Tools -> The xtrabackup binary -> The xtrabackup option reference".
It seems unintuitive that the parameters accepted by xtrabackup are listed under "Features". The documentation page is "Percona Xtrabackup - Documentation", which means we consider the xtrabackup binary to be a tool of Percona Xtrabackup, and having that binary is a feature of Percona Xtrabackup, which is confusing to me.
Ideally, it should be easy to find a documentation page by following the indexed entries, but even though I knew the exact page (and page name) I was looking for, I had to expand almost all of the options before finding it. This difficulty would be the same for every binary's option reference (xtrabackup, xbcloud, xbcrypt, xbstream). I'm opening this case to request reconsidering the indexing on PXB. If reverting back to the 2.4 structure is not an option, I'd propose making "Tools" a root entry in the index (and perhaps renaming it to "Binaries"). That would also be very intuitive if one is looking for the parameters accepted by any of the Percona Xtrabackup binaries/tools.