DLPX-84378 Update docs package dependencies to latest version in virtualization-sdk (#456)

DLPX-84378 Update docs package dependencies to latest version in virtualization-sdk (#456)

Author: SumoSourabh

.github/workflows/publish-docs.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.7 ]
+        python-version: [ 3.8 ]
         package: [ docs ]
         repository: [ 'delphix/virtualization-sdk' ]
 

docs/Pipfile

@@ -4,12 +4,12 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-mkdocs = "==0.17.5"
-mkdocs-material = "==2.9.2"
-markdown-include = "==0.5.1"
-mkdocs-awesome-pages-plugin = "==1.2.0"
+mkdocs = "==1.4.2"
+mkdocs-material = "==9.0.6"
+markdown-include = "==0.8.0"
+mkdocs-awesome-pages-plugin = "==2.8.0"
 
 [requires]
-python_version = "3.7"
+python_version = "3.8"
 
 [dev-packages]

docs/Pipfile.lock

@@ -23,21 +23,21 @@ Your user's home directory will depend on the operating system, but can be refer
 The CLI configuration file supports the following options:
 
 ### engine
-Specifies the Delphix Engine which can be used as part of the [dvp upload](/References/CLI.md#upload) or [dvp download-logs](/References/CLI.md#download-logs) command.
+Specifies the Delphix Engine which can be used as part of the [dvp upload](../References/CLI.md#upload) or [dvp download-logs](../References/CLI.md#download-logs) command.
 
 ```
 engine = engine.example.com
 ```
 
 ### user
-Specifies the user to a Delphix Engine which is used as part of the [dvp upload](/References/CLI.md#upload) or [dvp download-logs](/References/CLI.md#download-logs) command.
+Specifies the user to a Delphix Engine which is used as part of the [dvp upload](../References/CLI.md#upload) or [dvp download-logs](../References/CLI.md#download-logs) command.
 
 ```
 user = admin
 ```
 
 ### password
-Specifies the password for the user to a Delphix Engine which is used as part of the [dvp upload](/References/CLI.md#upload) or [dvp download-logs](/References/CLI.md#download-logs) command.
+Specifies the password for the user to a Delphix Engine which is used as part of the [dvp upload](../References/CLI.md#upload) or [dvp download-logs](../References/CLI.md#download-logs) command.
 
 ```
 password = userpassword

docs/docs/Best_Practices/CLI_Configuration_File.md

@@ -34,7 +34,7 @@ Any module in the plugin could import `execution_util.py` with `from utils impor
 
 	Note that the `srcDir` in the plugin config file (`src` in this example) does _not_ need an `__init__.py` file.
 
-	For information on which vSDK versions run on Python 2.7, visit the [Version Compatibility Page](/References/Version_Compatibility/#virtualization-sdk-and-python-compatibility-map).
+	For information on which vSDK versions run on Python 2.7, visit the [Version Compatibility Page](../References/Version_Compatibility.md#virtualization-sdk-and-python-compatibility-map).
 
 Assume `schema.json` contains:
 
@@ -151,7 +151,7 @@ def execute_shell(source_connection, script_name):
 !!! warning
     If developing a plugin in Python 2.7, you will need to use `pkgutil.get_data` rather than `importlib.resources.read_text`.
 
-    See [Managing Scripts For Remote Execution](/Best_Practices/Managing_Scripts_For_Remote_Execution.md) for more info.
+    See [Managing Scripts For Remote Execution](Managing_Scripts_For_Remote_Execution.md) for more info.
 
 !!! note
-	Both `execute_sql` and `execute_shell` use the `check` parameter which will cause an error to be raised if the exit code is non-zero. For more information refer to the `run_bash` [documentation](/References/Platform_Libraries.md#run_bash).
+	Both `execute_sql` and `execute_shell` use the `check` parameter which will cause an error to be raised if the exit code is non-zero. For more information refer to the `run_bash` [documentation](../References/Platform_Libraries.md#run_bash).

docs/docs/Best_Practices/Code_Sharing.md

@@ -2,13 +2,13 @@
 
 There are limits on how much data can be sent back and forth between the plugin and engine at a time. There are five scenarios where this comes into play:
 
-1. Inputs sent from the engine to the plugin, as arguments to a [Plugin Operation](/References/Plugin_Operations.md). For example, the schema-defined `Repository` object that is provided as input to plugin operations.
+1. Inputs sent from the engine to the plugin, as arguments to a [Plugin Operation](../References/Plugin_Operations.md). For example, the schema-defined `Repository` object that is provided as input to plugin operations.
 
 2. Outputs sent back from the plugin to the engine, as the return values from plugin operations.
 
-3. Exception messages and call stacks thrown by plugin code. For example, the `message` field within [User Visible Errors](/Best_Practices/User_Visible_Errors.md).
+3. Exception messages and call stacks thrown by plugin code. For example, the `message` field within [User Visible Errors](User_Visible_Errors.md).
 
-4. Inputs sent from the plugin to the engine, as arguments to a [Platform library](/References/Platform_Libraries.md) function. For example, the `message` field that is passed to `logger.debug`.
+4. Inputs sent from the plugin to the engine, as arguments to a [Platform library](../References/Platform_Libraries.md) function. For example, the `message` field that is passed to `logger.debug`.
 
 5. Outputs sent back from the engine to the plugin, as the return values from Platform Library functions. For example, the `stdout` resulting from a call to `libs.run_bash`.
 

docs/docs/Best_Practices/Message_Limits.md

@@ -16,7 +16,7 @@ Our Python 2.7 runtime environment only contains the [Python Standard Library](h
 
 If you want to use some Python module that is not part of the standard library, you might be able to do so.
 You would need to include that library as part of your plugin. That would involve downloading the source
-code for that module, and copying it into your source directory. For more information on how to lay out code in your source directory, see [Code Sharing](/Best_Practices/Code_Sharing.md).
+code for that module, and copying it into your source directory. For more information on how to lay out code in your source directory, see [Code Sharing](Code_Sharing.md).
 
 ### Warnings
 There are two major things to watch out for if you decide to incorporate a 3rd-party library.

docs/docs/Best_Practices/Runtime_Environment.md

@@ -6,7 +6,7 @@ A scratch path is a directory reserved for plugin use on each remote host. This
 - A place to mount VDB data
 - Temporary logs for debugging (Be careful that you don't use too much space though!)
 
-The location of this scratch area is given by the `scratch_path` property on the [RemoteHost](/References/Classes/#remotehost) object.
+The location of this scratch area is given by the `scratch_path` property on the [RemoteHost](../References/Classes.md#remotehost) object.
 
 
 Things to note about the scratch path:
@@ -15,5 +15,5 @@ Things to note about the scratch path:
 - No guarantees are made about how much space might be available in this directory. It is strongly advised that you use only a small amount of disk space here.
 - The directory will be owned by the "primary user" associated with the remote host. This might be a completely different user from the one that is associated with a particular dsource or VDB.
 - If you need to store dSource- or VDB-specific data, it is highly recommended that you create a separate subdirectory for each dSource/VDB inside this scratch area. It's also recommended to name this subdirectory using the GUID of the dSource/VDB, so that you avoid accidental name collisions.
-- The Delphix Engine will not do any cleanup for you, so be sure to delete anything you're no longer using. For example, any VDB-specific information must be deleted in your [unconfigure](/References/Plugin_Operations/#virtual-source-unconfigure) operation (and dSource data gets deleted in your [stopStaging](/References/Plugin_Operations/#staged-linked-source-stop-staging) operation.)
+- The Delphix Engine will not do any cleanup for you, so be sure to delete anything you're no longer using. For example, any VDB-specific information must be deleted in your [unconfigure](../References/Plugin_Operations.md#virtual-source-unconfigure) operation (and dSource data gets deleted in your [stopStaging](../References/Plugin_Operations.md#staged-linked-source-stop-staging) operation.)
 - Do not store any [sensitive information](Sensitive_Data.md) here!

docs/docs/Best_Practices/Scratch_Paths.md

@@ -12,7 +12,7 @@ Each of these tips are explained below.
 
 ## Marking Your Data As Sensitive
 
-Because the Delphix Engine manages the storing and retrieving of plugin-defined data, it needs to know which pieces of data are sensitive. The plugin does this in its [schemas](/References/Glossary.md#schema), by using the special [`password`](/References/Schemas.md#password) keyword.
+Because the Delphix Engine manages the storing and retrieving of plugin-defined data, it needs to know which pieces of data are sensitive. The plugin does this in its [schemas](../References/Glossary.md#schema), by using the special [`password`](../References/Schemas.md#password) keyword.
 
 The following example of a schema defines an object with three properties, one of which is sensitive and tagged with the `password` keyword:
 
@@ -35,11 +35,11 @@ This tells the Delphix Engine to take special precautions with this password pro
 4. Clients of the Delphix Engine's public API will not be able to access the password.
 
 !!! note
-    Removing a previously added password property from a field and running a [Data Migration](/References/Glossary.md#data-migration) will expose the password in plaintext. If this is intentional, write a migration to ensure that the new property conforms to the new schema.
+    Removing a previously added password property from a field and running a [Data Migration](../References/Glossary.md#data-migration) will expose the password in plaintext. If this is intentional, write a migration to ensure that the new property conforms to the new schema.
 
 ## Protecting Sensitive Data with Password Vaults
 
-Plugins can also leverage the password vaults configured in the Delphix engine to avoid storing sensitive data in the engine itself. In addition, vaults can rotate secrets seamlessly behind the scenes without requiring Delphix users to update those secrets in the engine. To give users the option to choose between directly entering a secret, such as a password or private key, or retrieving it from a vault, Delphix provides [pre-defined credential types](/References/Schemas.md#delphix-specific-pre-defined-types).
+Plugins can also leverage the password vaults configured in the Delphix engine to avoid storing sensitive data in the engine itself. In addition, vaults can rotate secrets seamlessly behind the scenes without requiring Delphix users to update those secrets in the engine. To give users the option to choose between directly entering a secret, such as a password or private key, or retrieving it from a vault, Delphix provides [pre-defined credential types](../References/Schemas.md#delphix-specific-pre-defined-types).
 
 When using these special types, the example above becomes:
 
@@ -55,9 +55,9 @@ When using these special types, the example above becomes:
 }
 ```
 
-For details on how the user can provide the information required for a property such as `db_credentials_supplier`, see the [section on pre-defined types](/References/Schemas.md#delphix-specific-pre-defined-types).
+For details on how the user can provide the information required for a property such as `db_credentials_supplier`, see the [section on pre-defined types](../References/Schemas.md#delphix-specific-pre-defined-types).
 
-At runtime, the plugin code must convert the credentials information provided by the user into an actual set of credentials that the plugin can use. To do this, the plugin must call the library function [`retrieve_credentials`](/References/Platform_Libraries.md#retrieve_credentials). For example:
+At runtime, the plugin code must convert the credentials information provided by the user into an actual set of credentials that the plugin can use. To do this, the plugin must call the library function [`retrieve_credentials`](../References/Platform_Libraries.md#retrieve_credentials). For example:
 
 ```python
 from dlpx.virtualization import libs
@@ -73,7 +73,7 @@ def my_virtual_stop(virtual_source, repository, source_config):
 
 ## Using Environment Variables For Remote Data Passing
 
-Sometimes, a plugin will need to pass sensitive data to a remote environment. For example, perhaps a database command needs to be run on a [staging environment](/References/Glossary.md#staging-environment), and that database command will need to use a password.
+Sometimes, a plugin will need to pass sensitive data to a remote environment. For example, perhaps a database command needs to be run on a [staging environment](../References/Glossary.md#staging-environment), and that database command will need to use a password.
 
 ### Example
 Let us take a look at a very simple example where we need to shutdown a database called "inventory" on a target environment by using the `db_cmd shutdown inventory` command. This command will ask for a password on `stdin`, and for our example our password is "hunter2".

docs/docs/Best_Practices/Sensitive_Data.md

@@ -71,7 +71,7 @@ Here is an example of the first line of a Python file that uses the UTF-8 encodi
 ```
 
 If you do not specify an encoding, and the source code contains any non-ASCII characters, you will get errors
- when building the plugin using [dvp build](/References/CLI.md#build) or during the execution of a plugin operation.
+ when building the plugin using [dvp build](../References/CLI.md#build) or during the execution of a plugin operation.
 
 ### Example