Skip to content

Commit e83d8a8

Browse files
andiemontoyeahgarya-bitquillandiem-bq
authored
[AD-283] Misc documentation enhancements (#125)
* Move images to 'src/markdown/images' directory. Delete amazon-ca-certs.md, bi-tool-setup.md, ssh-tunnel.md. * AD-283: consolidate linked md files into setup.md. Information from files 'amazon-ca-certs.md', 'bi-tool-setup.md' and 'ssh-tunnel,md' combined into 'setup.md'. Dependencies corrected (safe deletion of files). Add instruction to give user read access to .pem file. Replace 'Next Steps' section in 'setup.md' with 'Driver Setup in BI Applications' which links to various BI tool driver setup instructions in separate markdown files. * BI tool instructions for Tableau, SQuirreL and DbVisualizer placed in separate markdown files. * Add BI tool instructions for Dbeaver and Microstrategy. * Images for GETTING_STARTED.md and shema-discovery.md renamed (lowercase) and moved to new sub-directories. In GETTING_STARTED.md, code with placeholders hyphenated, e.g. <key pair name>.pem changed to <key-pair-name>.pem. * Change parameter list and option list to a table. * Replace 'an SSH' with 'a SSH'. * Change 'Next Steps' section to 'Driver Setup in BI Applications'. Section 'Driver Setup in BI Applications' links to instructions on how to set up the driver in various BI tools which are outlined in separate markdown files. * In connection string parameter's table remove default values in 'Description' column. Default values are in column 'Default'. * Minor word changes in dbeaver driver setup document. Change 'Dbeaver' to 'DBeaver'. Change '(e.g. AmazonDB)' to '(e.g. AmazonDocDB)'. * Minor word changes in setup document. Change 'Dbeaver' to 'DBeaver'. Remove comment 'TODO: Get link for DocumentDB JDBC driver' since completed. * Change 'a SSH' to 'an SSH' in documentation. * Change 'Microstrategy' to 'MicroStrategy' in documentation.' * Documentation improvement for connection string. 'Data type' info of parameter moved from parameter name column to description column. * Documentation improvement: change 'documentdb-jdbc-1.0-SNAPSHOT-all.jar' to 'documentdb-jdbc-1.0.0-all.jar'. * Documentation improvement: for dbeaver driver setup, comments about username and password added. If database connection requires authorization, the username and password can be entered either during driver setup or when creating a new connection. Documentation enhanced to make it more clear. * Documentation improvement: in setup.md, enhanced 'Using an SSH Tunnel to Connect to Amazon DocumentDB' section. Two subsections added, one for 'The JDBC Connection String When Using an SSH Tunnel' and one for 'Using an External SSH Tunnel to Connect to Amazon DocumentDB'. * Documentation improvement: in setup.md, for SSH tunnel, additional internal ssh info added. Note added not to use localhost for internal ssh but to use cluster hostname instead. Example added as well. * Documentation improvement: remove internal ssh example since examples exist in other documentation. * Fix entry for default fetch size * Move fetch size entry to bottom of table * Commit Code Coverage Badge Co-authored-by: Gary Atwal <[email protected]> Co-authored-by: andiem-bq <[email protected]>
1 parent 68aa1f6 commit e83d8a8

File tree

52 files changed

+503
-415
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+503
-415
lines changed

.github/badges/branches.svg

+1-1

.github/badges/jacoco.svg

+1-1

GETTING_STARTED.md

+100-57

src/markdown/index.md

+3-5

src/markdown/schema/manage-schema-cli.md

+9-9

src/markdown/schema/schema-discovery.md

+1-1

src/markdown/setup/amazon-ca-certs.md

-16
This file was deleted.

src/markdown/setup/bi-tool-setup.md

-149
This file was deleted.

0 commit comments

Comments
 (0)