docs: describe tljh-config commands by referencing --help

By not providing specific examples, we reduce the maintenance effort I
believe. I didn't want to add examples for all tljh-config commands as
those were anyhow documented via --help, and it felt like too much
documentation to maintain to describe it better than that.
This commit is contained in:
Erik Sundell
2021-10-16 18:36:19 +02:00
parent 37b57ce346
commit 8629b3de32
2 changed files with 32 additions and 10 deletions

View File

@@ -161,14 +161,38 @@ Advanced: ``config.yaml``
is the recommended method of editing / viewing configuration since editing
YAML by hand in a terminal text editor is a large source of errors.
``Remove configuration values``
---------------------------------
To learn more, use the ``--help`` flag applied to ``tljh-config`` directly or
after providing a positional argument as command like ``remove-item`` to learn
more about those commands specifically.
Use the argument ``remove-item`` to delete a configuration value from the
``config.yaml`` file:
.. code-block:: bash
``tljh-config remove-item <item being removed>``
sudo tljh-config --help
After modifying the configuration, reload JupyterHub to apply changes
usage: tljh-config [-h] [--config-path CONFIG_PATH] {show,set,add-item,remove-item,reload} ...
``tljh-config reload``
positional arguments:
{show,set,add-item,remove-item,reload}
show Show current configuration
set Set a configuration property
add-item Add a value to a list for a configuration property
remove-item Remove a value from a list for a configuration property
reload Reload a component to apply configuration change
optional arguments:
-h, --help show this help message and exit
--config-path CONFIG_PATH
Path to TLJH config.yaml file
.. code-block:: bash
sudo tljh-config remove-item --help
usage: tljh-config remove-item [-h] key_path value
positional arguments:
key_path Dot separated path to configuration key to remove value from
value Value to remove from key_path
optional arguments:
-h, --help show this help message and exit

View File

@@ -1,2 +0,0 @@
Remove config values in the-littlest-jupyterhub by editing 'config.py' file
and making the change. ie. comment out or delete the value to be unset