Merge pull request #2252 from weaveworks/fix-links

Documentation improvements

site/features.md

@@ -6,44 +6,70 @@ menu_order: 15
 Browse the current feature set for Scope with links to relevant indepth topics:
 
  * [Topology Mapping](#topology-mapping)
+ * [Views in Scope](#views)
+ * [Graphic or Table Mode](#mode)
  * [Flexible Filtering](#flexible-filtering)
-    * [Powerful Search](#powerful-search)
+ * [Powerful Search](#powerful-search)
  * [Real-time App and Container Metrics](#real-time-app-and-container-metrics)
- * [Interact With and Manage Containers](#interact-with-and-manage-containers)
- * [Troubleshoot Apps](#troubleshoot-apps)
-
+ * [Troubleshoot and Manage Containers](#interact-with-and-manage-containers)
+ * [Generate Custom Metrics using the Plugin API](#custom-plugins)
+ 
 
 ##<a name="topology-mapping"></a>Topology Mapping
 
-Scope builds logical topologies of your application and infrastructure.  A topology is a collection of nodes and edges, where nodes can represent objects like processes, container or hosts.  In Scope, edges represent TCP connections between nodes.  Scope displays an intelligent map of your app, so that different node types can be easily viewed and specific microservices can be drilled down on and inspected.
+Scope builds logical topologies of your application and infrastructure.  A topology is a collection of nodes and edges, where nodes represent objects like processes, container or hosts.  In Scope, edges indicate TCP connections between nodes.  Different node types can be filtered on and viewed and specific microservices can be drilled down on and inspected. Nodes are presented in a particular order with the clients above servers. As a general rule, you can read a Weave Scope view by going from top to bottom.
+
+!['Automatic Topology Mapping in Graph Mode'](images/topology-map.png)
+
+##<a name="views"></a>Views in Scope
+
+Views in Scope can be thought of as high-level filters on your containerized microservices as they run in the cloud. They are categorized into: Processes, Containers, Orchestrators, and Hosts. The Orchestrator view is context-sensitive, and as a result, if an app is running in Kubernetes, then Scope displays Pods, Replica Sets, Deployments, and Services that allow you to drilldown on Kubernetes clusters. 
+
+!['Kubernetes Views in Scope'](images/kubernetes-view.png)
+
+If your app is deployed to the Amazon EC2 cluster service, then Scope displays Services and Tasks that make up an ECS cluster.
+
+!['ECS Views in Scope'](images/ECS-view-tasks.png)
+
+For information on how to install Scope on Kubernetes see, "[Installing Scope on Kubernetes](installing.md#k8s)
+
+For information on how to install Scope on the AWS EC2 Container Service see, "[Installing Scope on Amazon ECS](installing.md#ecs)
+
+Under the hosts view, and if you are running Weave Net for container networking, a specific Weave Net view appears. This view is useful for troubleshooting any networking problems you may be having. This view displays a number of Weave Net specific attributes such as whether quorum has been reached, the IP addresses used, whether fast datapath is enabled, or if encryption is running and many other useful attributes. See [Weave Net User Guide](https://www.weave.works/docs/net/latest/features/) for more information. 
+
+##<a name="mode"></a>Graphic or Table Mode
+
+In addition to these views, nodes can be presented either in graphical or in table mode. The graphical mode is practical for obtaining a quick visual overview of your app, its infrastructure and connections between all of the nodes. And when you switch to table mode, nodes are presented in a convenient list that displays the resources being consumed by processes, containers, and hosts by dynamically shifting the resource heavy nodes to the top of the table, much like the UNIX `top` command does. 
+
+!['Table Mode Displaying Nodes by resource usage'](images/table-mode.png)
 
-!['Automatic Topology Mapping'](images/topology.png)
+##<a name="flexible-filtering"></a>Flexible Filtering
 
-##<a name="flexible-view-filtering"></a>Flexible Filtering
+In the left-hand corner of the UI are other filtering and other options. Nodes can be filtered by CPU and Memory so that you can easily find containers using the most resources. In the container view, options are available to filter by system, application or to show all of the containers and if you are running an app in Kubernetes then your app can be filtered by namespace and by container state whether running or stopped or contained and uncontained. 
 
-Nodes can be filtered by various properties, for example in the Container view, you can filter by System Containers vs Application Containers or by Stopped vs. Running Containers. Scope can also display various metrics such as CPU and Memory usage in the nodes, for example allowing you to easily find the container using the most CPU or memory.  Mouse-over any of the nodes to view its filtered metric at a glance.
+!['CPU usage indicator in Weave Scope'](images/hosts-cpu.png)
 
-###<a name="powerful-search"></a> Powerful Search
+##<a name="powerful-search"></a> Powerful Search
 
-Powerful search capability enables you to find node types, containers and processes by name, label or even path.  The search functionality supports simple operands so that you can for example, find processes consuming a certain Memory limit or nodes using too much CPU. You can also stack filters to create custom, complex search criterion. 
+Use Search to quickly find node types, containers and processes by name, label or even path.  The search functionality supports simple operands so that you can for example, find processes consuming a certain amount memory or nodes using too much CPU. Search terms may also be stacked to create custom, complex search criterion. See the online help within the product for a full list of allowable operands.
 
-!['Stack Filters'](images/search-python.png)
+!['Powerful Search'](images/search.png)
 
 ##<a name="real-time-app-and-container-metrics"></a>Real-time App and Container Metrics
 
-View contextual metrics, tags and metadata for your containers.  Effortlessly navigate between processes inside your container to the hosts that your containers run on, arranged in expandable, sortable tables.
+View contextual metrics, tags and metadata for your containers by clicking on a node to display its details panel. Drilldown on processes inside your container to the hosts that your containers run on, arranged in expandable, sortable tables.
 
 Choose an overview of your container infrastructure, or focus on a specific microservice. Identify and correct issues to ensure the stability and performance of your containerized applications.
 
-##<a name="interact-with-and-manage-containers"></a>Interact With and Manage Containers
+##<a name="interact-with-and-manage-containers"></a>Troubleshoot and Manage Containers
 
-Interact with your containers directly: pause, restart and stop containers without having to leave the Scope browser window.
+Click on a container, pod or host to view the controls that allow you to: pause, restart, stop and delete without having to leave the Scope browser window. Logs of selected containers or pods (if you are running Kubernetes) can also be displayed by clicking the terminal icon.
 
-##<a name="troubleshoot-apps"></a>Troubleshoot Apps
+And if further troubleshooting is required, terminal windows can be launched from any container or host so that you can interact with your app and run any UNIX command to diagnose issues.  Launch a terminal by clicking the `>_` icon from the details panel of a selected container or host. 
 
-A convenient terminal window is provided that enables you to interact with your app and to troubleshoot and diagnose any issues all within the same context.
+!['Terminal for container interaction'](images/terminal-view.png)
 
-##<a name="generate-custom-metrics-using-the-plugin-api"></a>Generate Custom Metrics using the Plugin API
+##<a name="custom-plugins"></a>Generate Custom Metrics using the Plugin API
 
 Scope includes a Plugin API, so that custom metrics may be generated and integrated with the Scope UI.
 

site/installing.md

@@ -22,7 +22,8 @@ The following topics are discussed:
    * [Using Docker Compose](#docker-compose)
    * [Using Docker Compose in Weave Cloud](#docker-compose-cloud)
  * [Installing Scope on Kubernetes](#k8s)
-   * [Using Weave Cloud](#k8s-weave-cloud)
+   * [With Weave Cloud](#k8s-weave-cloud)
+   * [Without Weave Cloud](#k8s-standalone)   
  * [Installing Scope on Amazon ECS](#ecs)
  * [Installing Scope on minimesos](#minimesos)
  * [Installing Scope on Mesosphere DC/OS](#dcos)
@@ -214,7 +215,7 @@ Note that you will need to launch Scope onto every node that you want to monitor
 
 ##<a name="k8s"></a>Installing Scope on Kubernetes
 
-### With Weave Cloud (recommended)
+###<a name="k8s-weave-cloud"></a>With Weave Cloud (recommended)
 
 Weave Cloud hosts the Scope UI for you, provides secure access control for your team and saves resources such as CPU or memory usage.
 
@@ -224,7 +225,7 @@ Sign up for a [Weave Cloud account](https://cloud.weave.works/) and obtain a tok
 
 **SECURITY NOTE: This allows control of your Kubernetes cluster from Weave Cloud, which is a hosted service.**
 
-### Without Weave Cloud (run Scope in standalone mode)
+###<a name="k8s-standalone"></a>Without Weave Cloud (run Scope in standalone mode)
 
 The simplest way to get the latest release of Scope deployed onto a Kubernetes cluster is by running the following: