changes to monitoring user doc - mostly language fixes (#955)

* doc wording changes * fixing language and removing "hub_port=55055 * fixing English and removing "hub_port=55055" (default) from monitoring * small additional fix * typo
Parsl · May 23, 2019 · 3d0bbf26e811b0a09d1578af512c15e74577e03c · 3d0bbf2
1 parent 1820e45
commit 3d0bbf26e811b0a09d1578af512c15e74577e03c
Unified Split

Showing with 11 additions and 12 deletions.

+11 −12 docs/userguide/monitoring.rst
diff --git a/docs/userguide/monitoring.rst b/docs/userguide/monitoring.rst
@@ -2,15 +2,15 @@ Monitoring
 ==========
 Parsl aims to make the task of running parallel workflows easy by providing monitoring and diagnostic
-  
-capabilities to help track the state of your workflow down to the individual applications being
-  
-executed on remote machines. To enable Parsl's monitoring feature for your workflow you will need
+  
+capabilities to help track the state of your workflow, down to the individual applications being
+  
+executed on remote machines. To enable Parsl's monitoring feature for your workflow, you will need
 a few additional packages.
 Installation
 ------------
-  
-Parsl's monitoring model relies on writing workflow progress to a sqlite database and separate tools
-  
-that query this database to create web-based dashboard for the workflow.
+  
+Parsl's monitoring model relies on writing workflow progress to a sqlite database and using separate tools
+  
+that query this database to create a web-based dashboard for the workflow.
 To enable workflow monitoring support install::
@@ -19,7 +19,7 @@ To enable workflow monitoring support install::
 Monitoring configuration
 ------------------------
-  
-Here's an example configuration that logs monitoring information to a local sqlite database.
+  
+Here's an example configuration that logs monitoring information to a local sqlite database:: 
 .. code-block:: python
@@ -42,7 +42,6 @@ Here's an example configuration that logs monitoring information to a local sqli
        ],
        monitoring=MonitoringHub(
            hub_address=address_by_hostname(),
-  
-            hub_port=55055,
            logging_level=logging.INFO,
            resource_monitoring_interval=10,
        ),
@@ -58,23 +57,23 @@ Install the visualization server::
   $ pip install git+https://github.com/Parsl/viz_server.git
-  
-Once `viz_server` is installed, you can run the utility `parsl-visualize` in the directory with the
+  
+Run the `parsl-visualize` utility in the directory with the
 `monitoring.db` sqlite file to launch a web page for the workflow visualization::
   $ parsl-visualize sqlite:///<absolute-path-to-db>
-  
-For example, if the `monitoring.db` is at `/tmp/monitoring.db`, run the `parsl-visualize` as follows::
+  
+For example, if `monitoring.db` is in `/tmp` (as `/tmp/monitoring.db`), run `parsl-visualize` as follows::
   $ parsl-visualize sqlite:////tmp/monitoring.db
-  
-This starts a visualization web server on `127.0.0.1:8080` by default. If you are running on a local machine with web browser, you can access viz_server via `127.0.0.1:8080`. Otherwise if you are running on the login node of a cluster, to access viz_server on local browser, you need an ssh tunnel from your local machine to the cluster::
+  
+This starts a visualization web server on `127.0.0.1:8080` by default. If you are running on a machine with a web browser, you can access viz_server in the browser via `127.0.0.1:8080`. If you are running on the login node of a cluster, to access viz_server in a local machine's browser, you need an ssh tunnel from your local machine to the cluster::
   $ ssh -L 50000:127.0.0.1:8080 username@cluster_address
-  
-This binds your local port 50000 to the remote cluster's localhost port 8080. So you can access viz_server directly on your local browser via `127.0.0.1:50000`. 
+  
+This binds your local machine's port 50000 to the remote cluster's port 8080. This allows you to access viz_server directly on your local machine's browser via `127.0.0.1:50000`. 
-  
-.. warning:: Below is an alternative to host the viz_server, which may violate the security policy of a cluster. Please confirm with your cluster admin.
-  
-If the cluster allows you to host the web server on its public IP address with a specific port (i.e., open to Internet via `public_IP:55555`), you can run::
+  
+.. warning:: Below is an alternative to host the viz_server, which may violate the cluster's security policy. Please check with your cluster admin before doing this.
+  
+If the cluster allows you to host a web server on its public IP address with a specific port (i.e., open to Internet via `public_IP:55555`), you can run::
   $ parsl-visualize -e --port 55555 sqlite:///<absolute-path-to-db>