DOC notes about (new) installation documentation

[prjemian]

@rodolakis commented (offline) about these aspects of the new installation documentation:

• For whom is the new documentation written? (BCDA staff or beamline staff)
  • assumes knowledge of less common bash shell:
  • commands such as head and less
  • command as pipes
  • environment variables
  • line continuation characters
  • the Hello, World! example could reference explanations, as these aspects are used
  • Code examples should state the language of the example.
• What else can become_bluesky alias do?
• APS PV gateway was not defined, so could not check PV S:SRcurrentAI
• In command line examples, make the prompt shorter (the long one causes confusion)
• Installation of the APS Data Management (DM) tools failed to find the dm package in Python
  • The Python test should print something, such as render the api object. Gives positive feedback for the test.

Here are the brief notes collected from the discussion:

aliases

alias become_bluesky='conda activate ${BLUESKY_ENVIRONMENT} '

alias become_bluesky='source /APSshare/miniconda/x86_64/activate ${BLUESKY_ENVIRONMENT} '

alias become_bluesky='activate_conda ${BLUESKY_ENVIRONMENT} '

command header is too long

Change

(base) user@host:~$

to

$

Unfamiliar bash command(s)

What is head?

Hello, World! example

Don't know why doing each step. Provide reference to explanations (such as %run)

testing.md

In the ophyd section, what is the language of the code example? (bash, but say it).

In the APS Data Management section, the conda install command uses () and this is a problem. Need to investigate why Fanny gets no module named 'dm'. Also note these are bash commands (same as before).

[prjemian]

Per StackExchange:

<pre>
$ <b>wc -l ~/.bash_aliases</b>
135
</pre>

which displays as:

$ wc -l ~/.bash_aliases
135

[prjemian]

investigate why Fanny gets no module named 'dm'.

Comes from this package: https://github.com/BCDA-APS/bluesky_training/blob/b9fc87bf266cd9a8f190da35683d09f56055b544/environment.yml#L36

[prjemian]

@rodolakis : Can we push this to the next milestone?