auto: Keyman for developer help deployment

Author: keyman-server

developer/18.0/context/options.md

@@ -125,42 +125,73 @@ Update database
 
 ![Options dialog - Server tab](../images/ui/frmOptions_Server.png)
 
-There are two configurations in the Keyman Developer Server section:
-1. Configure Server...
-2. List local URLs for Server
+### Configure Server dialog
 
-Configure Server...
+After clicking the **Configure Server...** button, a new window will pop-up:
 
-:   After clicking the button, a new window will pop-up
+![Keyman Developer Server Options dialog](../images/ui/frmKeyman_Developer_Server_Options.png)
 
-    ![Keyman Developer Server Options dialog](../images/ui/frmKeyman_Developer_Server_Options.png)
+You can customize the Keyman Developer Server for testing your keyboard online
+and on other devices. Features of the Keyman Developer Server include:
 
-    You can customize the Keyman Developer server for testing the usability of your keyboard. Features of the Keyman Developer server include:
+* Seamless integration with the IDE (Start, Stop, Live reload, Recompile...)
+* Sharing keyboards for testing online and on other devices
+* Allowing testing across devices and networks
 
-    * Seamless integration with the IDE (Start, Stop, Live reload, Recompile...)
-    * Port configuration
-    * Allow testing cross devices
-    * Wider range support for NGROK...
+Keyman Developer Server integrates with a free tool called
+[ngrok](https://ngrok.com) that provides a public URL to your instance of Keyman
+Developer Server. This URL is dynamic and can change over time, and is only
+available while Keyman Developer Server is running. This URL can be accessed
+from any mobile device that is online, whether or not it is on your local
+network. This means you can also quickly share keyboards, packages, and models
+with other users, with a minimum of difficulty.
 
-    [Find out more](https://github.com/keymanapp/keyman/pull/6073)
+* [Learn more about ngrok](server#ngrok)
 
-    Understanding the three tick boxes will enhance the usability of Keyman Developer:
-    - **Leave Server running after closing IDE**: allows keyboard testing on local URLs after closing Keyman Developer.
-    - **Use ngrok to provide public url for web debugger**: configure NGROK as instructed, once it looks something like this:
-    ![Keyman Developer NGROK](../images/ui/frmNGROK_Config.png)
+**Options available in this dialog:**
 
-        Please restart the machine, and the URL (*link ending in .ngrok-free.app*) will appear in the specified locations:
-        ![Keyman Developer NGROK URL 1](../images/ui/frmNGROK_Server_1.png)
-        ![Keyman Developer NGROK URL 2](../images/ui/frmNGROK_Server_2.png)
+- **Leave Server running after closing IDE**: allows keyboard testing on local
+  URLs even if Keyman Developer is not running.
 
-        Now, freely share it across multiple devices using the link or QR code.
-        ![Keyboard Test on Mobile](../images/ui/NGROK_Phone.png)
+- **Use ngrok to provide public url for web debugger**: enable ngrok
+  integration; you may need to download additional components; see below:
 
-    - **Show server console window on start**: once ticked, Keyman Developer's server console will appear as an independent window as a node application with the default message:
-        `Starting Keyman Developer Server 17.0.290-beta, listening on port 8008.`
+- **Download or update ngrok**: If the text next to this button shows 'Not
+  installed', press the button to download the required component
 
-List local URLs for Server
-:   Below Configure Server, untick the box, and it will quit displaying any local URLs for keyboard testing.
-    ![Keyman Developer Server Options dialog](../images/ui/frmList_Local_URLs.png)
+- **Install required redistributable**: ngrok requires an additional Microsoft
+  VC++ redistributable component; if the text next to this button shows 'Not
+  installed', press the button and follow the prompts to install the
+  redistributable component.
 
-Explore more: [Keyman Developer Server](server#toc-configuring-keyman-developer-server)
+After enabling ngrok, a URL with ending a domain such as `.ngrok-free.app` will
+appear in the Tools/Server menu and the Web and Mobile debugger pages in the
+Keyboard Editor and the Package Editor:
+
+![Tools/Options/Server menu showing ngrok](../images/ui/tools_options_server_ngrok.png)
+
+![Web and Mobile test showing ngrok](../images/ui/web_and_mobile_test_ngrok.png)
+
+Once this is active, you can access Keyman Developer Server across multiple
+devices and networks using the link or QR code.
+
+- **Show server console window on start**: once ticked, Keyman Developer's
+  server console will appear as an independent window as a node application,
+  which may be helpful if you encounter errors as they will appear in the
+  console.
+
+  A default message will appear when the server console starts, similar to:
+  `Starting Keyman Developer Server <version>-beta, listening on port 8008.`
+
+### List local URLs for Server
+
+When selected, Keyman Developer will show you more local URLs in the
+Tools/Server menu for accessing Keyman Developer Server from your browser. Some
+of these URLs will work only on your local computer, and will not work on other
+devices. Deselect this option in order to show only the most relevant access
+URLs. (On some networks, it may be helpful to see all the available URLs.)
+
+
+## Related links
+
+* [Keyman Developer Server](server#toc-configuring-keyman-developer-server)

developer/18.0/context/server.md

@@ -292,7 +292,7 @@ context as well.
 The devices listed are representative of the various types of platforms that
 Keyman supports, to allow testing on each of the available form factors.
 
-## Making your Keyman Developer Server instance globally available with ngrok
+## Making your Keyman Developer Server instance globally available with ngrok {#ngrok}
 
 One of the fiddliest parts of testing keyboards and models with mobile devices
 is transferring the files to your phone or tablet. Keyman Developer Server will
@@ -320,28 +320,30 @@ configure ngrok manually.
    click **Configure Server...**. You should be presented with a window similar
    to this:
 
-    ![](images/config.png)
+    ![](../images/ui/frmKeyman_Developer_Server_Options.png)
 
 2. Tick the box **Use ngrok to provide public url for Server**
-3. If ngrok is available, a version number will be shown to the right of the
+3. If ngrok is available, the text 'Installed' will be shown to the right of the
    **Download or update ngrok** button. Otherwise, click this button to download
    the latest version.
-4. You'll need a free ngrok account, so click the **Create free ngrok
+4. **Install required redistributable**: ngrok requires an additional Microsoft
+   VC++ redistributable component; if the text next to this button shows 'Not
+   installed', press the button and follow the prompts to install the
+   redistributable component.
+5. You'll need a free ngrok account, so click the **Create free ngrok
    account...** button to open the ngrok website, and follow the steps there
    to finish the account creation process.
-5. After creating the account, you should be presented with an authentication
+6. After creating the account, you should be presented with an authentication
    token. You can also access this by clicking the **Get token** link in the
    Keyman Developer Server Options dialog box. Paste this token into the
    **Authentication token** edit box.
-6. Select the most appropriate region for your location, to minimize the latency
-   (delay) when using the ngrok service.
 7. Click **OK** to save changes, and start the ngrok service within Keyman
    Developer Server.
 
 Once ngrok is configured, you should see an additional **Server** menu item in
 Keyman Developer's **Tools** menu, with three items:
 
-**Open `https://some-url.ngrok.io` in browser**
+**Open `https://some-url.ngrok-free.app` in browser**
 
 : Opens the public URL to your current Keyman Developer Server instance in the
   default browser on your computer.
@@ -353,15 +355,7 @@ Keyman Developer's **Tools** menu, with three items:
 
 **Configure...**
 
-: Opens the Keyman Developer Server Options dialog box.
-
-# Configuring Keyman Developer Server
-
-Keyman Developer Server has a number of configuration options. On Windows, using
-Keyman Developer is the easiest way to manage these options. Open **Tools |
-Options**, select **Server** tab, and click **Configure Server...**.
-
-![](images/config.png)
+: Opens the [Keyman Developer Server Options](options#server-tab) dialog box.
 
 ## Configuration Files
 

developer/18.0/images/ui/NGROK_Phone.png

@@ -13,3 +13,7 @@ title: Compiler Messages Reference for @keymanapp/common-types
 [KM01007](km01007) | `ERROR_TestDataUnexpectedArray` | Problem reading test data: expected single <param> element, found multiple
 [KM01008](km01008) | `ERROR_InvalidXml` | The XML file could not be read: 
 [KM01009](km01009) | `ERROR_InvalidPackageFile` | Package source file is invalid: unknown error
+[KM0100A](km0100a) | `ERROR_InvalidProjectFile` | Project file is not valid: <param>
+[KM0100B](km0100b) | `ERROR_UnsupportedProjectVersion` | Project version <param> is not supported by this version of Keyman Developer\.
+[KM0100C](km0100c) | `ERROR_ProjectFileCouldNotBeRead` | Project file could not be read
+[KM0100D](km0100d) | `ERROR_NotAPackageFile` | Package source file is not a valid \.kps file because it is missing the <Package> root element\.

developer/18.0/images/ui/frmKeyman_Developer_Server_Options.png

@@ -0,0 +1,11 @@
+---
+title: KM0100A: ERROR_InvalidProjectFile
+---
+
+|            |           |
+|------------|---------- |
+| Message    | Project file is not valid: <param> |
+| Module     | [common-types.CommonTypesMessages](common-types.commontypesmessages) |
+| Identifier | `ERROR_InvalidProjectFile` |
+
+

developer/18.0/images/ui/frmNGROK_Config.png

@@ -0,0 +1,11 @@
+---
+title: KM0100B: ERROR_UnsupportedProjectVersion
+---
+
+|            |           |
+|------------|---------- |
+| Message    | Project version <param> is not supported by this version of Keyman Developer\. |
+| Module     | [common-types.CommonTypesMessages](common-types.commontypesmessages) |
+| Identifier | `ERROR_UnsupportedProjectVersion` |
+
+