Update Local Server readme instructions (#627)

* add additional information for how to change local server version manually

* format readmes

* remove end comma from tags

* fix formatting and update metadata style checker

* fix geoprocessing formatting

* further formatting

* fix typos

* update local server install text following review

* update formatting and url link

* update bullets

* asterisks

Co-authored-by: Rachael Ellen <[email protected]>

Author: Rachael-E

.github/scripts/ci/readme_metadata_style_check/metadata_style_checker.py

@@ -79,7 +79,7 @@ def parse_tags(tags_string: str) -> typing.List[str]:
     tags = tags_string.split(',')
     if not tags:
         raise Exception('README Tags parse failure!')
-    return sorted([tag.strip() for tag in tags])
+    return sorted([tag.strip() for tag in tags], key=str.casefold)
 
 def get_folder_name_from_path(path: str, index: int = -1) -> str:
     """

local_server/local-server-feature-layer/README.md

@@ -17,18 +17,18 @@ A Local Server and Local Feature Service will automatically be started. Once sta
 1. Create and run a local server with `LocalServer.INSTANCE`.
 2. Start the server asynchronously with `Server.startAsync()`.
 3. Wait for server to be in the  `LocalServerStatus.STARTED` state.
-   * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
+    * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
 4. Create and run a local feature service.
-   1. Instantiate `LocalFeatureService(Url)` to create  a local feature service with the given url path to mpk file.
-   2. Start the service asynchronously with `LocalFeatureService.startAsync()`.
-      * The service will be added to the local server automatically.
+    1. Instantiate `LocalFeatureService(Url)` to create a local feature service with the given url path to mpk file.
+    2. Start the service asynchronously with `LocalFeatureService.startAsync()`.
+        * The service will be added to the local server automatically.
 5. Wait for state of the feature service to be `LocalServerStatus.STARTED`.
-   * Callbacks attached to `LocalFeatureService.addStatusChangedListener()` will invoke whenever the status of the local service has changed.
+    * Callbacks attached to `LocalFeatureService.addStatusChangedListener()` will invoke whenever the status of the local service has changed.
 6. Create a feature layer from local feature service.
-   1. Create a `ServiceFeatureTable(Url)` from local feature service url provided by `LocalFeatureService.getUrl()`.
-   2. Load the table asynchronously using `ServiceFeatureTable.loadAsync()`.
-   3. Create feature layer from service feature table using `new FeatureLayer(ServiceFeatureTable)`.
-   4. Load the layer asynchronously using `FeatureLayer.loadAsync()`.
+    1. Create a `ServiceFeatureTable(Url)` from local feature service url provided by `LocalFeatureService.getUrl()`.
+    2. Load the table asynchronously using `ServiceFeatureTable.loadAsync()`.
+    3. Create feature layer from service feature table using `new FeatureLayer(ServiceFeatureTable)`.
+    4. Load the layer asynchronously using `FeatureLayer.loadAsync()`.
 7. Add feature layer to map using `ArcGISMap.getOperationalLayers().add(FeatureLayer)`.
 
 ## Relevant API
@@ -41,7 +41,16 @@ A Local Server and Local Feature Service will automatically be started. Once sta
 
 ## Additional information
 
-Local Server can be downloaded for Windows and Linux platforms. Local Server is not supported on macOS.
+Local Server can be downloaded for Windows and Linux platforms from your [ArcGIS Developers dashboard](https://developers.arcgis.com/java/local-server/install-local-server/). Local Server is not supported on macOS.
+
+Specific versions of ArcGIS Runtime Local Server are compatible with the version of ArcGIS Pro you use to create geoprocessing and map packages. For example, the ArcGIS Runtime API for Java v100.10.0 is configured for Local Server v100.10.0 which provides compatibility for packages created with ArcGIS Pro 2.7.x. For more information see the [ArcGIS Developers guide](https://developers.arcgis.com/java/reference/system-requirements/#local-server-version-compatibility-with-arcgis-desktop-and-arcgis-pro).
+
+To configure the ArcGIS Runtime API for Java v100.10.0 to work with Local Server 100.9.0:
+
+* Development machine:
+    * Locate the Local Server installation directory and rename the folder from `LocalServer100.9` to `LocalServer100.10`.
+    * Update the environment variable from `RUNTIME_LOCAL_SERVER_100_9` to `RUNTIME_LOCAL_SERVER_100_10`.
+* Deployment machine(s): Rename the deployment folder included with your application (or referenced by the LocalServerEnvironment.InstallPath property) from `LocalServer100.9` to `LocalServer100.10`.
 
 ## Tags
 

local_server/local-server-geoprocessing/README.md

@@ -21,7 +21,7 @@ Contour Line Controls (Top Left):
 1. Create and run a local server with `LocalServer.INSTANCE`.
 2. Start the server asynchronously with `Server.startAsync()`.
 3. Wait for server to be in the  `LocalServerStatus.STARTED` state.
-   * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
+    * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
 4. Start a `LocalGeoprocessingService` and run a `GeoprocessingTask`.
     1. Instantiate `LocalGeoprocessingService(Url, ServiceType)` to create a local geoprocessing service.
     2. Invoke `LocalGeoprocessingService.start()` to start the service asynchronously.
@@ -52,8 +52,17 @@ Contour Line Controls (Top Left):
 
 ## Additional information
 
-Local Server can be downloaded for Windows and Linux platforms. Local Server is not supported on macOS.
+Local Server can be downloaded for Windows and Linux platforms from your [ArcGIS Developers dashboard](https://developers.arcgis.com/java/local-server/install-local-server/). Local Server is not supported on macOS.
+
+Specific versions of ArcGIS Runtime Local Server are compatible with the version of ArcGIS Pro you use to create geoprocessing and map packages. For example, the ArcGIS Runtime API for Java v100.10.0 is configured for Local Server v100.10.0 which provides compatibility for packages created with ArcGIS Pro 2.7.x. For more information see the [ArcGIS Developers guide](https://developers.arcgis.com/java/reference/system-requirements/#local-server-version-compatibility-with-arcgis-desktop-and-arcgis-pro).
+
+To configure the ArcGIS Runtime API for Java v100.10.0 to work with Local Server 100.9.0:
+
+* Development machine:
+    * Locate the Local Server installation directory and rename the folder from `LocalServer100.9` to `LocalServer100.10`.
+    * Update the environment variable from `RUNTIME_LOCAL_SERVER_100_9` to `RUNTIME_LOCAL_SERVER_100_10`.
+* Deployment machine(s): Rename the deployment folder included with your application (or referenced by the LocalServerEnvironment.InstallPath property) from `LocalServer100.9` to `LocalServer100.10`.
 
 ## Tags
 
-geoprocessing, local, offline, parameters, processing, service,
+geoprocessing, local, offline, parameters, processing, service

local_server/local-server-map-image-layer/README.md

@@ -17,17 +17,17 @@ The Local Server and local map service will automatically be started and, once r
 1. Create and run a local server with `LocalServer.INSTANCE`.
 2. Start the server asynchronously with `Server.startAsync()`.
 3. Wait for server to be in the  `LocalServerStatus.STARTED` state.
-   * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
+    * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
 4. Create and run a local service, example of running a `LocalMapService`.
     1. Instantiate `LocalMapService(Url)` to create a local map service with the given URL path to the map package (`mpk` file).
     2. Start the service asynchronously with `LocalFeatureService.startAsync()`. The service is added to the Local Server automatically.
 5. Wait for the state of the map service to be `LocalServerStatus.STARTED`.
-   * Callbacks attached to `LocalFeatureService.addStatusChangedListener()` will invoke whenever the status of the local service has changed.
+    * Callbacks attached to `LocalFeatureService.addStatusChangedListener()` will invoke whenever the status of the local service has changed.
 6. Create an ArcGIS map image layer from local map service.
-   1. Create a `ArcGISMapImageLayer(Url)` from local map service url provided by `LocalMapService.getUrl()`.
-   2. Add the layer to the map's operational layers.
-   3. Connect to the map image layer's `LoadStatusChanged` signal.
-   4. When the layer's status is `Loaded`, set the map view's extent to the layer's full extent.
+    1. Create a `ArcGISMapImageLayer(Url)` from local map service url provided by `LocalMapService.getUrl()`.
+    2. Add the layer to the map's operational layers.
+    3. Connect to the map image layer's `LoadStatusChanged` signal.
+    4. When the layer's status is `Loaded`, set the map view's extent to the layer's full extent.
 
 ## Relevant API
 
@@ -38,7 +38,16 @@ The Local Server and local map service will automatically be started and, once r
 
 ## Additional information
 
-Local Server can be downloaded for Windows and Linux platforms. Local Server is not supported on macOS.
+Local Server can be downloaded for Windows and Linux platforms from your [ArcGIS Developers dashboard](https://developers.arcgis.com/java/local-server/install-local-server/). Local Server is not supported on macOS.
+
+Specific versions of ArcGIS Runtime Local Server are compatible with the version of ArcGIS Pro you use to create geoprocessing and map packages. For example, the ArcGIS Runtime API for Java v100.10.0 is configured for Local Server v100.10.0 which provides compatibility for packages created with ArcGIS Pro 2.7.x. For more information see the [ArcGIS Developers guide](https://developers.arcgis.com/java/reference/system-requirements/#local-server-version-compatibility-with-arcgis-desktop-and-arcgis-pro).
+
+To configure the ArcGIS Runtime API for Java v100.10.0 to work with Local Server 100.9.0:
+
+* Development machine:
+    * Locate the Local Server installation directory and rename the folder from `LocalServer100.9` to `LocalServer100.10`.
+    * Update the environment variable from `RUNTIME_LOCAL_SERVER_100_9` to `RUNTIME_LOCAL_SERVER_100_10`.
+* Deployment machine(s): Rename the deployment folder included with your application (or referenced by the LocalServerEnvironment.InstallPath property) from `LocalServer100.9` to `LocalServer100.10`.
 
 ## Tags
 

local_server/local-server-services/README.md

@@ -21,11 +21,11 @@ To start a `LocalServer` and attach a `LocalService`:
 1. Create and run a local server with `LocalServer.INSTANCE`.
 2. Start the server asynchronously with `Server.startAsync()`.
 3. Wait for server to be in the  `LocalServerStatus.STARTED` state.
-   * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
+    * Callbacks attached to `Server.addStatusChangedListener()` will invoke whenever the status of the local server has changed.
 4. Create and run a local service. Here is an example of running a `LocalMapService`:
     1. Instantiate `LocalMapService(Url)` to create a local map service with the given URL path to map package (`mpk` or `mpkx` file).
-    2. Start the job with `LocalMapServic.estartAsync()`.
-       * The service is added to the `LocalServer` automatically.
+    2. Start the job with `LocalMapService.startAsync()`.
+        * The service is added to the `LocalServer` automatically.
 
 To stop a `LocalServer` and any attached `LocalServices`:
 
@@ -44,7 +44,16 @@ To stop a `LocalServer` and any attached `LocalServices`:
 
 ## Additional information
 
-Local Server can be downloaded for Windows and Linux platforms. Local Server is not supported on macOS.
+Local Server can be downloaded for Windows and Linux platforms from your [ArcGIS Developers dashboard](https://developers.arcgis.com/java/local-server/install-local-server/). Local Server is not supported on macOS.
+
+Specific versions of ArcGIS Runtime Local Server are compatible with the version of ArcGIS Pro you use to create geoprocessing and map packages. For example, the ArcGIS Runtime API for Java v100.10.0 is configured for Local Server v100.10.0 which provides compatibility for packages created with ArcGIS Pro 2.7.x. For more information see the [ArcGIS Developers guide](https://developers.arcgis.com/java/reference/system-requirements/#local-server-version-compatibility-with-arcgis-desktop-and-arcgis-pro).
+
+To configure the ArcGIS Runtime API for Java v100.10.0 to work with Local Server 100.9.0:
+
+* Development machine:
+    * Locate the Local Server installation directory and rename the folder from `LocalServer100.9` to `LocalServer100.10`.
+    * Update the environment variable from `RUNTIME_LOCAL_SERVER_100_9` to `RUNTIME_LOCAL_SERVER_100_10`.
+* Deployment machine(s): Rename the deployment folder included with your application (or referenced by the LocalServerEnvironment.InstallPath property) from `LocalServer100.9` to `LocalServer100.10`.
 
 ## Tags