ADD websocket.md to the right directory and include it in indexes

telefonicaid · Apr 12, 2016 · 90e6cea · 90e6cea
1 parent e44406d
commit 90e6cea
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/doc/manuals/user/README.md b/doc/manuals/user/README.md
@@ -26,3 +26,4 @@
   * [Security considerations](security.md)
   * [Known Limitations](known_limitations.md)
   * [Considerations on NGSIv1 and NGSIv2 coexistence](v1_v2_coexistence.md)
+  * [Websockets interface](websockets.md) (experimental)
diff --git a/doc/websockets.md → doc/manuals/user/websockets.md b/doc/websockets.md → doc/manuals/user/websockets.md
@@ -1,5 +1,7 @@
 # Websockets interface
 
+**This is yet experimental functionality. Usage feedback is highly welcomed, but don't rely on it for production, as changes are expected.**
+
 ## What is this?
 
 The websockets interface is a new way to communicate with Orion using websockets, this is point to improve the comunication with a faster and more efficient protocol, because now we have a persistent connection with an open socket. Also websockets are a way of easing the interaction between Orion and client applications running in browsers and smartphone.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,6 +35,7 @@ pages:
       - 'Forbidden characters': 'user/forbidden_characters.md'
       - 'Docker': 'user/docker.md'
       - 'Considerations on NGSIv1 and NGSIv2 coexistence': 'user/v1_v2_coexistence.md'
+      - 'Websockets interface (experimental)': 'user/websockets.md'
   - 'Installation & Administration Manual':
       - 'Introduction': 'admin/index.md'
       - 'Installing Orion': 'admin/install.md'