New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add openqa-cli documentation #3009
Conversation
I did not touch the other guides yet (which also contain some small client sections). And i'm not sure where in the overall documentation it belongs. Placing it above Pitfalls is just a starting point. |
fd1acde
to
b8916fd
Compare
Codecov Report
@@ Coverage Diff @@
## master #3009 +/- ##
==========================================
+ Coverage 91.88% 91.89% +0.01%
==========================================
Files 207 207
Lines 12835 12835
==========================================
+ Hits 11793 11795 +2
+ Misses 1042 1040 -2
Continue to review full report at Codecov.
|
cf7038a
to
c1ceda1
Compare
|
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like openqa.opensuse.org might be a better default if you just wanna try and look at the potential use cases. 🤔 Although I gather this could be construed as "too specific to opensuse" somehow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You also don't want random people cause load on O3 with test requests, or accidentally pasted destructive examples being run against O3 by people who have the credentials to do damage. 😉
a3314c0
to
6e91513
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall this reads like a very nicely written guide and I think it can be helpful and also motivate more users to try out the API when previously maybe they only used the web UI. I think the current level of detail you hit is exactly right. We have only a tiny overlap which I think you handle well with "You have seen a few examples earlier", etc. :)
901ee2b
to
aced943
Compare
aced943
to
0df6100
Compare
So far we don't have much client documentation, even though most openQA users will interact with it directly. This is my first attempt at collecting everything i could think of and turning it into a new guide. Still needs some cleanups and perhaps more diverse examples, but the main points are there.
Progress: https://progress.opensuse.org/issues/10316
Feature PR: #2859