Update doc links to point to new doc on readthedocs

2023-02-21 15:18:03 +11:00 · 2023-02-21 15:18:03 +11:00 · 8fd73548be
parent ffd4f2c160
commit 8fd73548be
17 changed files with 41 additions and 41 deletions
--- a/README.md
+++ b/README.md
@ -46,7 +46,7 @@ have been made by the community.

 ## <a name="license"></a> License

-Copyright (c) 2015, 2022, Oracle and/or its affiliates.
+Copyright (c) 2015, 2023, Oracle and/or its affiliates.

 This software is dual-licensed to you under the Universal Permissive License
 (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@ -68,15 +68,15 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.

-[1]: https://oracle.github.io/node-oracledb/doc/api.html#getstarted
-[2]: https://oracle.github.io/node-oracledb/INSTALL.html#quickstart
+[1]: https://node-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#getstarted
+[2]: https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart
 [3]: https://github.com/oracle/node-oracledb/issues
 [4]: https://oracle.github.io/node-oracledb
 [5]: https://node-oracledb.slack.com/
 [6]: https://join.slack.com/t/node-oracledb/shared_invite/enQtNDU4Mjc2NzM5OTA2LWMzY2ZlZDY5MDdlMGZiMGRkY2IzYjI5OGU4YTEzZWM5YjQ3ODUzMjcxNWQyNzE4MzM5YjNkYjVmNDk5OWU5NDM
 [30]: https://github.com/oracle/node-oracledb/blob/main/examples
 [31]: https://github.com/oracle/node-oracledb/blob/main/examples/example.js#L32
-[32]: https://oracle.github.io/node-oracledb/doc/api.html
+[32]: https://node-oracledb.readthedocs.io/en/latest/
 [33]: https://github.com/oracle/node-oracledb/blob/main/CHANGELOG.md
 [34]: https://github.com/oracle/node-oracledb/blob/main/test/README.md
 [35]: https://github.com/oracle/node-oracledb/blob/main/CONTRIBUTING.md
--- a/examples/README.md
+++ b/examples/README.md
@ -2,11 +2,11 @@

 This directory contains [node-oracledb](https://www.npmjs.com/package/oracledb)
 examples.  Documentation is
-[here](https://oracle.github.io/node-oracledb/doc/api.html).
+[here](https://node-oracledb.readthedocs.io/en/latest/).

 To run the examples:

- [Install node-oracledb](https://oracle.github.io/node-oracledb/INSTALL.html#quickstart).
+- [Install node-oracledb](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart).

 - Edit `dbconfig.js` and set your username and the database connection string,
  for example:
--- a/examples/aqmulti.js
+++ b/examples/aqmulti.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -29,7 +29,7 @@
 *   Oracle Advanced Queuing (AQ) example passing multiple messages.
 *
 *   Before running this, a queue allowing RAW payloads must be
- *   created, see https://oracle.github.io/node-oracledb/doc/api.html#aqrawexample
+ *   created, see https://node-oracledb.readthedocs.io/en/latest/user_guide/aq.html#aqrawexample
 *
 *   This example requires node-oracledb 4 or later.
 *
--- a/examples/aqobject.js
+++ b/examples/aqobject.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -30,7 +30,7 @@
 *
 *   Before running this, a queue allowing an Oracle Database object
 *   payload must be created, see
- *   https://oracle.github.io/node-oracledb/doc/api.html#aqobjexample
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/aq.html#aqobjexample
 *
 *   This example requires node-oracledb 4 or later.
 *
--- a/examples/aqoptions.js
+++ b/examples/aqoptions.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -28,8 +28,8 @@
 * DESCRIPTION
 *   Oracle Advanced Queuing (AQ) example setting options and message attributes.
 *
- *   Before running this, a queue allowing RAW payloads must be
- *   created, see https://oracle.github.io/node-oracledb/doc/api.html#aqrawexample
+ *   Before running this, a queue allowing RAW payloads must be created, see
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/aq.html#aqrawexample
 *
 *   This example requires node-oracledb 4 or later.
 *
--- a/examples/aqraw.js
+++ b/examples/aqraw.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2019, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -28,8 +28,8 @@
 * DESCRIPTION
 *   Basic Oracle Advanced Queuing (AQ) example passing text messages.
 *
- *   Before running this, a queue allowing RAW payloads must be
- *   created, see https://oracle.github.io/node-oracledb/doc/api.html#aqrawexample
+ *   Before running this, a queue allowing RAW payloads must be created, see
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/aq.html#aqrawexample
 *
 *   This example requires node-oracledb 4 or later.
 *
--- a/examples/calltimeout.js
+++ b/examples/calltimeout.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2018, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -27,7 +27,7 @@
 *
 * DESCRIPTION
 *   Shows how to time out long running database calls.
- *   See https://oracle.github.io/node-oracledb/doc/api.html#dbcalltimeouts
+ *   See https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#dbcalltimeouts
 *
 *   This example requires node-oracledb 3 (or later) and Oracle Client 18c
 *   libraries (or later).
--- a/examples/connectionpool.js
+++ b/examples/connectionpool.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2018, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -34,7 +34,7 @@
 *
 *   In some networks forced pool termination may hang unless you have
 *   'disable_oob=on' in sqlnet.ora, see
- *   https://oracle.github.io/node-oracledb/doc/api.html#tnsadmin
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#limiting-the-time-taken-to-execute-statements
 *
 *   In production applications, set poolMin=poolMax (and poolIncrement=0)
 *
--- a/examples/dbconfig.js
+++ b/examples/dbconfig.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2015, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -91,10 +91,10 @@ module.exports = {
  password      : process.env.NODE_ORACLEDB_PASSWORD,

  // For information on connection strings see:
-  // https://oracle.github.io/node-oracledb/doc/api.html#connectionstrings
+  // https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connectionstrings
  connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING || "localhost/orclpdb1",

  // Setting externalAuth is optional.  It defaults to false.  See:
-  // https://oracle.github.io/node-oracledb/doc/api.html#extauth
+  // https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth
  externalAuth  : process.env.NODE_ORACLEDB_EXTERNALAUTH ? true : false
 };
--- a/examples/soda1.js
+++ b/examples/soda1.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2018, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -30,7 +30,7 @@
 *
 *   Requires Oracle Database and Client 18.3, or higher.
 *   The user must have been granted the SODA_APP and CREATE TABLE privileges.
- *   See https://oracle.github.io/node-oracledb/doc/api.html#sodaoverview
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/soda.html#sodaoverview
 *
 *   This example requires node-oracledb 3.0 or later.
 *
--- a/examples/webapp.js
+++ b/examples/webapp.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2015, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2015, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -33,7 +33,7 @@
 *
 *   In some networks forced pool termination may hang unless you have
 *   'disable_oob=on' in sqlnet.ora, see
- *   https://oracle.github.io/node-oracledb/doc/api.html#tnsadmin
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#limiting-the-time-taken-to-execute-statements
 *
 *   In production applications, set poolMin=poolMax (and poolIncrement=0)
 *
--- a/lib/util.js
+++ b/lib/util.js
@ -1,4 +1,4 @@
-// Copyright (c) 2016, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2016, 2023, Oracle and/or its affiliates.

 //-----------------------------------------------------------------------------
 //
@ -49,7 +49,7 @@ const STAGING_DIR = 'package/Staging';

 // getInstallURL returns a string with installation URL
 function getInstallURL() {
-  return ('Node-oracledb installation instructions: https://oracle.github.io/node-oracledb/INSTALL.html');
+  return ('Node-oracledb installation instructions: https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html');
 }


--- a/package/README.md
+++ b/package/README.md
@ -48,5 +48,5 @@ The
 in GitHub doesn't have an `install` script target by default.  This means that
 node-gyp will be invoked to compile node-oracledb.  This allows installation
 from GitHub [source
-code](https://oracle.github.io/node-oracledb/INSTALL.html#github) when no
-suitable pre-built binary is available.
+code](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#github)
+when no suitable pre-built binary is available.
--- a/test/README.md
+++ b/test/README.md
@ -43,7 +43,7 @@ limitations under the License.

 ## <a name="preparations"></a> 1. Preparations

-See [INSTALL](https://oracle.github.io/node-oracledb/INSTALL.html)
+See [INSTALL](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html)
 for installation details.

 On macOS, run a command like:
@ -98,7 +98,7 @@ Set the following environment variables to provide credentials for the test suit

 * `NODE_ORACLEDB_CONNECTIONSTRING` provides the connection string that points to your database's location.

-* `NODE_ORACLEDB_EXTERNALAUTH` provides the options for external authentication tests. Setting this environment variable to "true" will enable the tests that require external authentication. To ensure external authentication tests works, firstly make sure the Oracle external authentication service is correctly configured. See [Documentation for External Authentication](https://oracle.github.io/node-oracledb/doc/api.html#extauth) for details.
+* `NODE_ORACLEDB_EXTERNALAUTH` provides the options for external authentication tests. Setting this environment variable to "true" will enable the tests that require external authentication. To ensure external authentication tests works, firstly make sure the Oracle external authentication service is correctly configured. See [Documentation for External Authentication](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth) for details.

 * `NODE_ORACLEDB_DBA_PRIVILEGE` provides the options for DBA privilege. Setting this environment variable to "true" will enable the tests and utilities that require DBA privilege.

@ -144,14 +144,14 @@ The following test(s) are automatically skipped if their required environment va
 ### <a name="externalproxyauth"></a> 3.1 externalProxyAuth.js
 This test aims to test the combined usage of external authentication and proxy authentication. To run this test, you need to complete the following prerequisite setups.

-* Enable external authentication on the schema user which you used for testing. See [Documentation for External Authentication](https://oracle.github.io/node-oracledb/doc/api.html#extauth) for more information on external authentication. Then use the following command to enable external authentication in the test suite.
+* Enable external authentication on the schema user which you used for testing. See [Documentation for External Authentication](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth) for more information on external authentication. Then use the following command to enable external authentication in the test suite.

    ```
    export NODE_ORACLEDB_EXTERNALAUTH true

    ```

-* Enable proxy authentication on another schema user specified by environment variable `NODE_ORACLEDB_PROXY_SESSION_USER` that connects through the schema user which you used for testing. See [Documentation for Pool Proxy Authentication](https://oracle.github.io/node-oracledb/doc/api.html#pool-proxy-authentication) for more information on proxy authentication. Then use the following command to enable proxy authentication in the test suite.
+* Enable proxy authentication on another schema user specified by environment variable `NODE_ORACLEDB_PROXY_SESSION_USER` that connects through the schema user which you used for testing. See [Documentation for Pool Proxy Authentication](https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#pool-proxy-authentication) for more information on proxy authentication. Then use the following command to enable proxy authentication in the test suite.

    ```
    export NODE_ORACLEDB_PROXY_SESSION_USER "Your_Proxy_Authenticating_User"
--- a/test/driverName.js
+++ b/test/driverName.js
@ -1,4 +1,4 @@
-/* Copyright (c) 2016, 2022, Oracle and/or its affiliates. */
+/* Copyright (c) 2016, 2023, Oracle and/or its affiliates. */

 /******************************************************************************
 *
@ -31,7 +31,7 @@
 *   Note that enabling the externalAuth feature requires configuration on the
 *   database besides setting "externalAuth" attribute to be true. Please refer
 *   to api doc about the configuration.
- *   https://oracle.github.io/node-oracledb/doc/api.html#extauth
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth
 *
 *****************************************************************************/

--- a/test/externalAuth.js
+++ b/test/externalAuth.js
@ -30,8 +30,8 @@
 *
 *   Note that enabling the externalAuth feature requires configuration on the
 *   database besides setting "externalAuth" attribute to be true. Please refer
- *   to api doc about the configuration.
- *   https://oracle.github.io/node-oracledb/doc/api.html#extauth
+ *   to API documentation about configuration.
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth
 *
 *****************************************************************************/
 'use strict';
--- a/test/multipleLobInsertion.js
+++ b/test/multipleLobInsertion.js
@ -30,8 +30,8 @@
 *
 *   Note that enabling the externalAuth feature requires configuration on the
 *   database besides setting "externalAuth" attribute to be true. Please refer
- *   to api doc about the configuration.
- *   https://oracle.github.io/node-oracledb/doc/api.html#extauth
+ *   to API documentation about configuration.
+ *   https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth
 *
 *****************************************************************************/
 'use strict';