doc: Improve openqa-cli documentation

* Add reference to the client documentation in the REST-API section * Improve wording
BillAnastasiadis · Jul 12, 2021 · 1ccacfc · 1ccacfc
1 parent 7030a92
commit 1ccacfc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/Client.asciidoc b/docs/Client.asciidoc
@@ -9,7 +9,7 @@ There are two ways to interact with openQA as a user. The web UI and the REST
 API. In this guide we will focus on the latter. You've probably already seen a
 few examples of its use with `openqa-cli` earlier in the documentation.
 
-Here we will start again from the very beginning. To give you a more complete
+Here we will start again from the very beginning to give you a more complete
 overview of its capabilities. To get started all you need is an openQA instance
 with a few jobs and `curl`. Just replace `openqa.example.com` in the examples
 below with the hostname of your openQA instance.

diff --git a/docs/UsersGuide.asciidoc b/docs/UsersGuide.asciidoc
@@ -873,6 +873,10 @@ without needing to install openQA itself. Call `openqa-cli --help` for help.
 The sub-commands provide further help, e.g. `openqa-cli api --help` contains
 a lot of examples.
 
+This section focuses on particular API use-cases. Checkout the
+<<Client.asciidoc#client,openQA client>> section for further information about
+the client itself, how authentication works and how plain `curl` can be used.
+
 === Triggering tests
 
 Tests can be triggered over multiple ways, using `openqa-clone-job`,