Merge pull request #277 from douglasjacobsen/docs_and_debugging

Add debug info to docs, and docs link to readme
GoogleCloudPlatform · Oct 6, 2023 · 571fe94 · 571fe94
2 parents d55f13f + 447cfaf
commit 571fe94
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,9 @@ spack for some application definition. See
 Documentation
 ----------------
 
+Ramble’s documentation can be viewed at
+[https://googlecloudplatform.github.io/ramble/](https://googlecloudplatform.github.io/ramble/).
+
 For help with Ramble’s commands, run `ramble help` or `ramble help --all`.
 
 For more information on concepts in Ramble, see Ramble’s

diff --git a/lib/ramble/docs/getting_started.rst b/lib/ramble/docs/getting_started.rst
@@ -124,6 +124,20 @@ For help with sub-commands, the ``-h`` flag can be used:
 
    $ ramble <subcommand> -h
 
+^^^^^^^^^^^^^^^^
+Debugging Ramble
+^^^^^^^^^^^^^^^^
+
+When an issue occurs while running Ramble, it can be useful to get additionally
+debugging information. To enable the debugging mode in Ramble, you can use the
+`-d` global option, as follows:
+
+.. code-block:: console
+
+    $ ramble -d <subcommand>
+    or;
+    $ ramble --debug <subcommand>
+
 ---------------------
 Defined Applications
 ---------------------