From cb005dbb5e11b841a725880a0703712499c9c584 Mon Sep 17 00:00:00 2001
From: Pete R Jemian <prjemian@users.noreply.github.com>
Date: Mon, 26 Feb 2024 10:51:22 -0600
Subject: [PATCH] Cite hello world in installation checklist, generalize for
 queueserver (#279)

* MNT @241 suggested changes

* DOC #241 reference the Hello World! notebook
---
 CHANGES.rst                                        | 1 +
 bluesky/user/quick_hello.py                        | 4 ++--
 docs/source/instrument/_install_new_instrument.rst | 3 +--
 docs/source/instrument/_test_new_instrument.md     | 4 +++-
 4 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/CHANGES.rst b/CHANGES.rst
index 74e824be..76b14f24 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -43,6 +43,7 @@ New Features
 Maintenance
 ------------
 
+* Add 'Hello, World!' test to installation checklist.
 * Drop the (unused now) *stdlogpj* package for configuring Python's *logging*.
 * Environment for bluesky_2024_1.
 * Updates (from learned 2-ID) for new installations.
diff --git a/bluesky/user/quick_hello.py b/bluesky/user/quick_hello.py
index a6ac9f91..e0cc873f 100644
--- a/bluesky/user/quick_hello.py
+++ b/bluesky/user/quick_hello.py
@@ -1,5 +1,5 @@
 """
-Hello, World! demo for bluesky-queueserver testing.
+Demo 'Hello, World!' for testing, including bluesky-queueserver.
 
 EXAMPLE::
 
@@ -41,4 +41,4 @@ class HelloDevice(Device):
 
 def hello_world():
     """Simple bluesky plan for demonstrating Hello, World!."""
-    yield from bp.count([hello_device], md=dict(title="test QS"))
+    yield from bp.count([hello_device], md=dict(subtitle="test Bluesky"))
diff --git a/docs/source/instrument/_install_new_instrument.rst b/docs/source/instrument/_install_new_instrument.rst
index d7ca6521..0d1d44f5 100644
--- a/docs/source/instrument/_install_new_instrument.rst
+++ b/docs/source/instrument/_install_new_instrument.rst
@@ -17,6 +17,7 @@ to the documentation for each step.
 #. `create conda environment <https://bcda-aps.github.io/bluesky_training/reference/_create_conda_env.html>`__
 #. `configure IPython profile startup <https://bcda-aps.github.io/bluesky_training/reference/_ipython.html>`__
 #. `configure bash with environment variable and alias <https://bcda-aps.github.io/bluesky_training/reference/_create_conda_env.html#create-an-alias-to-activate-the-bluesky-environment>`__
+#. Verify the installation by running the `Hello, World! tutorial. <https://bcda-aps.github.io/bluesky_training/tutor/hello_world.html>`__
 #. create soft link:  ``ln -s ${HOME}/bluesky/blueskyStarter.sh ~/bin/``
 #. Assign a MongoDB catalog for databroker: `instructions for BCDA <https://git.aps.anl.gov/bcda/bluesky-catalogs/-/blob/master/README.md>`__
 #. `databroker catalog configuration <https://bcda-aps.github.io/bluesky_training/instrument/_configure_databroker.html#setup-your-databroker-catalog-configuration>`__
@@ -346,8 +347,6 @@ Note that the bluesky team recommends GitHub. (Why is that? See section
          </ul>
 
 
-
-
 The next steps are common to both web-based repositories (GitHub and GitLab):
 
 - copy the remote `repository URL <https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#choosing-a-url-for-your-remote-repository>`_, for example,
diff --git a/docs/source/instrument/_test_new_instrument.md b/docs/source/instrument/_test_new_instrument.md
index 9604f3af..7eb8ba7f 100644
--- a/docs/source/instrument/_test_new_instrument.md
+++ b/docs/source/instrument/_test_new_instrument.md
@@ -10,7 +10,9 @@ Visit <a href=https://bcda-aps.github.io/bluesky_training/instrument/_install_ne
 
 <details>
 <summary>How to test my Bluesky installation?</summary>
-Visit <a href=https://bcda-aps.github.io/bluesky_training/tutor/_hello_word.html> Hello World</a>.
+Test (verify) the installation by running the <a
+href=https://bcda-aps.github.io/bluesky_training/tutor/hello_world.html>Hello, World!</a>
+tutorial.
 </details>
 
 <br>