bugfix/server-pip-redis-conf (#443)

* add *.conf to the MANIFEST file so pip will grab the redis.conf file * add note explaining how to fix a hanging merlin server start * modify CHANGELOG * add second export option to docs and fix typo
LLNL · Aug 18, 2023 · c641c5c · c641c5c
1 parent b0f4d86
commit c641c5c
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 ### Added
+- The *.conf regex for the recursive-include of the merlin server directory so that pip will add it to the wheel
+- A note to the docs for how to fix an issue where the `merlin server start` command hangs
 
 ### Changed
 - Bump certifi from 2022.12.7 to 2023.7.22 in /docs

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,5 @@
 recursive-include merlin/data *.yaml *.py
-recursive-include merlin/server *.yaml *.py
+recursive-include merlin/server *.yaml *.py *.conf
 recursive-include merlin/examples *
 include requirements.txt
 include requirements/*

diff --git a/docs/source/merlin_server.rst b/docs/source/merlin_server.rst
@@ -1,7 +1,7 @@
 Merlin Server
 =============
 The merlin server command allows users easy access to containerized broker 
-and results servers for merlin workflows. This allowsusers to run merlin without
+and results servers for merlin workflows. This allows users to run merlin without
 a dedicated external server.
 
 The main configuration will be stored in the subdirectory called "server/" by 

diff --git a/docs/source/server/commands.rst b/docs/source/server/commands.rst
@@ -34,6 +34,13 @@ Starting up a Merlin Server (``merlin server start``)
 
 Starts the container located in the local merlin server configuration.
 
+.. note::
+    If this command seems to hang and never release control back to you, follow these steps:
+
+    1. Kill the command with ``Ctrl+C``
+    2. Run either ``export LC_ALL="C.UTF-8"`` or ``export LC_ALL="C"``
+    3. Re-run the ``merlin server start`` command
+
 Stopping an exisiting Merlin Server (``merlin server stop``)
 ------------------------------------------------------------