fix page

Author: CamDavidsonPilon

developer-guide/03-Background jobs/02-writing-background-jobs.md

@@ -384,20 +384,21 @@ This class works as is, but we also want to develop a command line interface for
 At the bottom of the file, we add:
 
 ```python
+from pioreactor.cli.run import run
 import click
 
-@click.command(name="motor_driver")
-@click.option(
+@run.command(name="motor_driver")
+@run.option(
     "--initial-dc",
     default=config.getfloat("motor_driver", "initial_duty_cycle"),
     show_default=True,
     type=click.FloatRange(0, 100, clamp=True),
 )
-@click.option(
+@run.option(
     "--hz",
     default=config.getfloat("motor_driver", "hz"),
     show_default=True,
-    type=click.FloatRange(1, 10_000, clamp=True),
+    type=click.FloatRange(1, 50_000, clamp=True),
 )
 def click_motor_driver(initial_dc, hz):
     """

developer-guide/07-Plugins/01-intro-plugins.md

@@ -55,6 +55,7 @@ Here's an example: place the following code into the file `/home/pioreactor/.pio
 import click
 from pioreactor.whoami import get_unit_name, get_assigned_experiment_name
 from pioreactor.background_jobs.base import BackgroundJob
+from pioreactor.cli.run import run
 
 __plugin_summary__ = "Just a demo job"
 __plugin_version__ = "0.0.1"
@@ -77,7 +78,7 @@ class DemoJob(BackgroundJob):
         self.logger.debug("Goodbye, world!")
 
 
-@click.command(name="demo_job", help=__plugin_summary__)
+@run.command(name="demo_job", help=__plugin_summary__)
 def click_demo_job():
 
     unit = get_unit_name()
@@ -87,12 +88,19 @@ def click_demo_job():
         experiment=experiment,
     )
     job.block_until_disconnected()
+
 ```
 
 You should be able to execute the following from the command line now: `pio run demo_job`.
 
 Finally, in your [web interface under plugins](http://pioreactor.local/plugins), you should see "Demo Job" installed.
 
+
+:::important
+Using `run.command` ensures `pio run` can discover your command.
+:::
+
+
 :::info
 [A full introduction to writing jobs](/developer-guide/writing-background-jobs) is available.
 :::
@@ -112,6 +120,7 @@ from pioreactor.background_jobs.stirring import start_stirring
 from pioreactor.background_jobs.od_reading import start_od_reading
 from pioreactor.actions.led_intensity import led_intensity
 from pioreactor.background_jobs.temperature_automation import start_temperature_automation
+from pioreactor.cli.run import run
 
 
 __plugin_summary__ = "My example script to control stirring, OD and temperature"
@@ -121,7 +130,7 @@ __plugin_author__ = "Cam Davidson-Pilon"
 __plugin_homepage__ = "https://docs.pioreactor.com"
 
 
-@click.command(name="my_script", help=__plugin_summary__) # the name field is used in the invocation `pio run X`
+@run.command(name="my_script", help=__plugin_summary__) # the name field is used in the invocation `pio run X`
 def click_my_script():
 
     led_intensity({"B": 50})
@@ -135,14 +144,11 @@ def click_my_script():
 
     stirrer.block_until_disconnected()
 
+
 ```
 
 You should be able to execute the following from the command line now: `pio run my_script`. (The `my_script` is from the `@click.command` line, you can change it there).
 
-:::important
-The function that `click.command` wraps should have it's name prepended by `click_`. Ex: `def click_my_script` is okay, but `def my_script` is not.
-:::
-
 :::info
 How do you add this to your /pioreactors page in the UI? See [here](/developer-guide/adding-plugins-to-ui).
 :::

user-guide/30-Advanced/02-networking/00-connecting-without-network.md

@@ -5,11 +5,9 @@ hide_table_of_contents: true
 ---
 
 
-info
-:::
 
+:::info
 This is still a bit experimental and may not work on all systems
-
 :::
 
 
@@ -25,7 +23,7 @@ This might work on Windows, too.
 5. Open up your terminal, and try the following:
 
    ```
-   ssh pioreactor@your leaders name.local
+   ssh pioreactor@your_leaders_name.local
    ``` 
 
    example:
@@ -41,7 +39,7 @@ This might work on Windows, too.
    hostname -I
    ```
 
-   This should provide an IP address. Try that in your browser's URL bar. Example: http://169.254.189.106. Then try: http://your leaders name.local.
+   This should provide an IP address. Try that in your browser's URL bar. Example: http://169.254.189.106. Then try: http://your_leaders_name.local.
 
 
 6. You can disconnect your Mac from the Pi's ethernet whenever and things will keep running on it, but note, when you reconnect, it may take a minute again to establish a connection. You should be able then view the UI and also SSH in.