Documentation improvements #2252

abuehrle · 2017-02-15T23:54:35Z

single anchor fixed

abuehrle · 2017-02-16T00:16:11Z

Updated screen captures.

Needs revisions to text as well.

2opremio · 2017-02-16T02:16:39Z

That search screenshot doesn't look right (the cart text in the canvas should be highlighted)

site/features.md


 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.

 ###<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. 

-!['Stack Filters'](images/search-python.png)


abuehrle · 2017-02-17T16:01:38Z

@2opremio PTAL Thinking about putting all of the search criterion on its own page as reference as well, wdyt? (expand what's in the online help for that).

site/features.md


-##<a name="troubleshoot-apps"></a>Troubleshoot Apps
+Troubleshoot your app by directly interacting with containers: pause, restart and stop containers without having to leave the Scope browser window.
+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.Select `<_` to launch a terminal in any container from the details panel. 


2opremio · 2017-02-17T16:50:39Z

@abuehrle You added a full refactoring of the docs, piggybacking on a PR supposed to fix an anchor. That's not a good practice, since it makes traceability difficult.

From now on please create separate PRs for different changes. Also, try to keep the PR title up to date if (only for a good reason) the PR scope changes.

site/features.md

-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.Select `<_` to launch a terminal in any container from the details panel. 
+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 in Kubernetes) can also be viewed by clicking the terminal icon.
+
+And if further troubleshooting is required, a convenient terminal window can also be launched from any container that enables you to 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. 


2opremio · 2017-02-17T22:31:03Z

Thinking about putting all of the search criterion on its own page as reference as well, wdyt?

OK by me

site/features.md

+
+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. 
+
+!['ECS Views in Scope'](images/kubernetes-view.png)


site/features.md

+
+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. 


site/features.md


-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. 
+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. Search terms may also be stacked to create custom, complex search criterion. See the online help for a full list of allowable operands.


site/features.md


 ##<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.


site/features.md


-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 in Kubernetes) can also be viewed by clicking the terminal icon.


site/features.md


-##<a name="troubleshoot-apps"></a>Troubleshoot Apps
+And if further troubleshooting is required, terminal windows can be launched from any container 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. 


abuehrle · 2017-02-20T17:50:33Z

I am finished with these changes for now. If I do more work on the scope docs, I'll create a new PR.

site/features.md


-And if further troubleshooting is required, terminal windows can be launched from any container 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. 
+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. 


2opremio · 2017-02-20T21:06:32Z

Yes, I did finish, see #2257 (comment)

…

On Mon, Feb 20, 2017 at 9:24 PM, Anita Buehrle ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In site/features.md <#2252 (comment)>: > -And if further troubleshooting is required, terminal windows can be launched from any container 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. +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. I like how all of my stuff get extra-special scrutiny. Have you finished reviewing that other open doc request yet? Or I guess this on is perfect: #2257 <#2257> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2252 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACQOJGNlgKIPX2qXGFSh-qiG9cwgjPwaks5refaBgaJpZM4MCaA9> .

2opremio · 2017-02-27T16:51:34Z

Ping

abuehrle added 2 commits February 15, 2017 17:54

fixed anchor tag

55393a3

update screen captures

c974606

added anchor for without WC

40fae7f

2opremio reviewed Feb 16, 2017

View reviewed changes

abuehrle added 6 commits February 15, 2017 20:31

show highlighted search

48e2508

adjust res and size

b4affe6

update and add new screen captures

5e60775

removed old screen captures

b78f59e

updated features description

959aef6

update index

a5b2cb8

ecs tasks file name updated

133586a

2opremio reviewed Feb 17, 2017

View reviewed changes

2opremio changed the title ~~fixed anchor tag~~ Documentation improvements Feb 17, 2017

abuehrle added 2 commits February 17, 2017 15:29

clarified container controls

bb0c41e

made terminal plural

2f2fbbb

2opremio reviewed Feb 17, 2017

View reviewed changes

multiple terminal windows

7a50ca3

fixed reversed icon

435ee9f

2opremio reviewed Feb 17, 2017

View reviewed changes

made suggested changes

7903aea

2opremio reviewed Feb 20, 2017

View reviewed changes

or hosts

36178e9

2opremio approved these changes Feb 21, 2017

View reviewed changes

abuehrle merged commit e1bbc5a into master Feb 28, 2017

rade deleted the fix-links branch July 5, 2017 13:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation improvements #2252

Documentation improvements #2252

abuehrle commented Feb 15, 2017

abuehrle commented Feb 16, 2017

2opremio commented Feb 16, 2017

This comment was marked as abuse.

abuehrle commented Feb 17, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

2opremio commented Feb 17, 2017 •

edited

Loading

This comment was marked as abuse.

2opremio commented Feb 17, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

abuehrle commented Feb 20, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

2opremio commented Feb 20, 2017 via email

2opremio commented Feb 27, 2017


		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.

		!['ECS Views in Scope'](images/kubernetes-view.png)


		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.


		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.
		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. Search terms may also be stacked to create custom, complex search criterion. See the online help for a full list of allowable operands.


		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 in Kubernetes) can also be viewed 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 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.

Documentation improvements #2252

Documentation improvements #2252

Conversation

abuehrle commented Feb 15, 2017

abuehrle commented Feb 16, 2017

2opremio commented Feb 16, 2017

This comment was marked as abuse.

abuehrle commented Feb 17, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

2opremio commented Feb 17, 2017 • edited Loading

This comment was marked as abuse.

2opremio commented Feb 17, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

abuehrle commented Feb 20, 2017

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

This comment was marked as abuse.

2opremio commented Feb 20, 2017 via email

2opremio commented Feb 27, 2017

2opremio commented Feb 17, 2017 •

edited

Loading