Bug #86140 shell docs may have many issues
Submitted: 29 Apr 2017 10:29 Modified: 8 Oct 2018 15:40
Reporter: Shane Bester (Platinum Quality Contributor) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S1 (Critical)
Version:5.7.18 OS:Any
Assigned to: CPU Architecture:Any

[29 Apr 2017 10:29] Shane Bester
Description:
I'm trying to follow the docs step-by-step to learn this stuff... 
So I started at the beginning and read every page in order, from
https://dev.mysql.com/doc/refman/5.7/en/mysql-shell.html

Some issues and their result:

1.
https://dev.mysql.com/doc/refman/5.7/en/mysql-shell-sessions.html
"3.8.2.1.2 Choosing a MySQL Shell Session Type"
"--x creates an XSession."
RESULT: mysqlsh: unknown option --x ........

2. used throughout the docs but doesn't work!
https://dev.mysql.com/doc/refman/5.7/en/mysql-shell-connections.html
 "mysql-js> var mysqlx=require('mysqlx').mysqlx;"
RESULT: 
Invalid object member mysqlx (AttributeError) .....

3. 
https://dev.mysql.com/doc/refman/5.7/en/mysql-shell-interactive-code-execution.html
 "var mySession = mysqlx.getSession('user:pwd@localhost');"
RESULT: 
mysql-js> var mysqlx = require('mysqlx')
mysql-js> var mySession = mysqlx.getSession('root:@localhost');
Invalid object member getSession (AttributeError)
mysql-js>

4.
https://dev.mysql.com/doc/dev/mysqlsh-api-javascript/group__mysqlx.html
has hyperlink to a 404 for "mysqlx" object!
https://dev.mysql.com/doc/dev/mysqlsh-api-javascript/namespacemysqlx.html

[gave up here]

How to repeat:
Read the docs for Shell and try to get anything working without knowing anything.
[29 Apr 2017 11:42] MySQL Verification Team
https://bugs.mysql.com/bug.php?id=85370
[2 May 2017 9:08] MySQL Verification Team
Hello Shane,

Thank you for the bug report and feedback!

Thanks,
Umesh
[8 Oct 2018 15:40] David Moss
Posted by developer:
 
Thanks for the feedback. In the meantime the docs have been reworked a lot by me, hopefully they are a bit more usable these days :)

Specific responses to your points:

1.

This option was removed, and the docs were updated.

2. 
This pattern was changed, and the docs were updated.

3.
Docs were updated.

4.
These docs are maintained by the devs, and in the meantime the web addresses have changed. We have requested multiple times that the HTML addresses be stable but until now nobody has provided a solution. Yeah it sucks but it's not something docs can fix unfortunately.