Troubleshooting revamped

src/main/_data/sidebars/che_7_docs.yml

@@ -180,9 +180,24 @@ entries:
         url: che-7/using-npm-artifact-repositories
         output: web
   - title: Troubleshooting for Che end users
-    url: che-7/troubleshooting-for-che-end-users
     output: web
-
+    folderitems:
+      - title: Overview
+        url: che-7/troubleshooting-for-che-end-users
+        output: web       
+      - title: Troubleshooting network problems
+        url: che-7/troubleshooting-network-problems
+        output: web      
+      - title: Restarting a Che workspace in debug mode after start failure
+        url: che-7/restarting-a-che-workspace-in-debug-mode-after-start-failure
+        output: web
+      - title: Starting a Che workspace in debug mode
+        url: che-7/starting-a-che-workspace-in-debug-mode
+        output: web
+      - title: Using different type of storage
+        url: che-7/using-different-type-of-storage
+        output: web
+
 
 # Installation Guide
 - title: Installation Guide

src/main/pages/che-7/end-user-guide/assembly_troubleshooting-for-che-end-users.adoc

@@ -14,12 +14,21 @@ summary:
 [id="troubleshooting-for-{prod-id-short}-end-users_{context}"]
 = Troubleshooting for {prod-short} end users
 
-:context: troubleshooting-for-che-end-users
+:context: troubleshooting-for-{prod-id-short}-end-users
+
+This section provides troubleshooting procedures for most frequent issues an user can came in conflict with.
+
+* xref:troubleshooting-network-problems_{context}[]
+* xref:restarting-a-{prod-id-short}-workspace-in-debug-mode-after-start-failure_{context}[]
+* xref:starting-a-{prod-id-short}-workspace-in-debug-mode_{context}[]
+* xref:using-different-type-of-storage_{context}[]
+
+include::proc_troubleshooting-network-problems.adoc[leveloffset=+1]
 
 include::proc_restarting-a-che-workspace-in-debug-mode-after-start-failure.adoc[leveloffset=+1]
 
 include::proc_starting-a-che-workspace-in-debug-mode.adoc[leveloffset=+1]
 
 include::proc_using-different-types-of-storage.adoc[leveloffset=+1]
 
-:context: {parent-context-of-troubleshooting-for-che-end-users}
+:context: {parent-context-of-troubleshooting-for-{prod-id-short}-end-users}

src/main/pages/che-7/end-user-guide/proc_restarting-a-che-workspace-in-debug-mode-after-start-failure.adoc

@@ -1,6 +1,24 @@
+---
+title: Restarting a Che workspace in debug mode after start failure
+keywords:
+tags: []
+sidebar: che_7_docs
+permalink: che-7/restarting-a-che-workspace-in-debug-mode-after-start-failure/
+folder: che-7/end-user-guide
+summary:
+---
+
+// Module included in the following assemblies:
+//
+// troubleshooting-for-che-end-users
+
+:page-liquid:
+
 [id="restarting-a-{prod-id-short}-workspace-in-debug-mode-after-start-failure_{context}"]
 = Restarting a {prod-short} workspace in debug mode after start failure
 
+:context: restarting-a-{prod-id-short}-workspace-in-debug-mode-after-start-failure
+
 This section describes how to restart the {prod} workspace in debug mode after a failure during workspace start.
 
 .Prerequisites

src/main/pages/che-7/end-user-guide/proc_starting-a-che-workspace-in-debug-mode.adoc

@@ -1,6 +1,24 @@
+---
+title: Starting a Che workspace in debug mode
+keywords:
+tags: []
+sidebar: che_7_docs
+permalink: che-7/starting-a-che-workspace-in-debug-mode/
+folder: che-7/end-user-guide
+summary:
+---
+
+// Module included in the following assemblies:
+//
+// troubleshooting-for-che-end-users
+
+:page-liquid:
+
 [id="starting-a-{prod-id-short}-workspace-in-debug-mode_{context}"]
 = Starting a {prod-short} workspace in debug mode
 
+:context: starting-a-{prod-id-short}-workspace-in-debug-mode
+
 This section describes how to start the {prod} workspace in debug mode.
 
 .Prerequisites

src/main/pages/che-7/end-user-guide/proc_troubleshooting-network-problems.adoc

@@ -0,0 +1,95 @@
+---
+title: Troubleshooting network problems
+keywords:
+tags: []
+sidebar: che_7_docs
+permalink: che-7/troubleshooting-network-problems/
+folder: che-7/end-user-guide
+summary:
+---
+
+// Module included in the following assemblies:
+//
+// troubleshooting-for-che-end-users
+
+
+:page-liquid:
+
+[id="troubleshooting-network-problems_{context}"]
+= Troubleshooting network problems
+
+:context: troubleshooting-network-problems
+
+Most often, connection problems occur because a firewall, proxy server, corporate network, or other network is configured in a way that blocks {prod-short}.
+
+The following section describes how to prevent or solve issues related to corporate network policies. The network administrator may be required to enable ports or WebSocket, which Che requires for proper functionality.
+
+Common scenarios:
+
+* Open additional ports for a specific web site.
+* Enable WebSockets on the proxy server.
+
+
+
+[id="enabling-the-websocket-protocol_{context}"]
+== Enabling the WebSocket protocol
+
+Enabling the WebSocket protocol is critical for the proper functionality of {prod-short} IDE.
+
+While the WebSocket protocol itself is unaware of proxy servers and firewalls, HTTP servers can share their default HTTP and HTTPS ports with a WebSocket server.
+
+* HTTP: port 80
+* HTTPS: port 433
+
+Some proxy servers operate with WebSockets by default, but others prevent WebSockets from working correctly, which causes the connection to fail.
+
+In some cases, the proxy server requires the additional configuration, and the specific proxy servers need an upgrade, which allows WebSockets support.
+
+
+
+[id="troubleshooting websocket-secure-connections_{context}"]
+== Troubleshooting WebSocket Secure connections
+
+Secure WebSocket connections improve confidentiality and also reliability because they reduce the risk of interference by bad proxies. {prod-short} operates under WebSocket Secure connections by default and usually no action is required. Some customer’s security policy blocks some aspects of the WebSocket protocol that causes problems with proper {prod-short} functionality. Those problems are however out of scope for {prod-short}  support and have to be solved by a network administrator. 
+
+To troubleshoot a failing WebSocket Secure (WSS) connection, use the instructions in this section.
+
+.Prerequisites
+
+Using an unsupported web browser causes a connection interruption, followed by a warning message.
+
+* Use a supported Web browser:
+
+** Chrome
+** Firefox
+
+* WebSockets protocol is enabled
+
+.Procedure
+
+. Browser support
+.. Check if WebSockets is running by a link:https://websocketstest.com/[realtime web test] using one of the supported browsers.
++
+If the problem wasn’t resolved, follow with the next step.
+
+
+. Proxy servers and firewalls settings
+.. Ask a system administrator to check if there is a proxy server or firewall that blocks WebSocket Secure (WSS) connections on port 443. 
++
+* Possible required actions:
+
+** Add an exception to the firewall 
+** Have the proxy intercept WebSocket connection 
+
+.Verification 
+* Check if WebSockets is running by a link:https://websocketstest.com/[realtime web test] using one of the supported browsers.
+
+
+////
+.Additional resources
+
+* A bulleted list of links to other material closely related to the contents of the procedure module.
+* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
+* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
+* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
+////

src/main/pages/che-7/end-user-guide/proc_using-different-types-of-storage.adoc

@@ -8,9 +8,17 @@ folder: che-7/end-user-guide
 summary:
 ---
 
+// Module included in the following assemblies:
+//
+// troubleshooting-for-che-end-users
+
+:page-liquid:
+
 [id="using-different-type-of-storage_{context}"]
 = Using different type of storage 
 
+:context: using-different-type-of-storage
+
 Since 7.17.0 Eclipse Che supports three types of storage with different capabilities: persistent storage, ephemeral and asynchronous.
 
 .Persistent storage
@@ -39,7 +47,7 @@ attributes:
  persistVolumes: ‘false’
 ----
 
-=== Comparison table between I/O of Ephemeral (`emptyDir`) vs Persitent (link:https://kubernetes.io/docs/concepts/storage/storage-classes/#aws-ebs[AWS EBS])
+== Comparison table between I/O of Ephemeral (`emptyDir`) vs Persitent (link:https://kubernetes.io/docs/concepts/storage/storage-classes/#aws-ebs[AWS EBS])
 
 [cols="3", options="header"]
 |===

src/main/pages/che-7/installation-guide/assembly_configuring-che-overview.adoc

@@ -8,6 +8,7 @@ folder: che-7/installation-guide
 summary:
 ---
 
+:page-liquid:
 :parent-context-of-configuring-che: {context}