Skip to content
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

Merged
merged 6 commits into from Apr 30, 2020
Merged

Add openqa-cli documentation #3009

merged 6 commits into from Apr 30, 2020

Conversation

kraih
Copy link
Member

@kraih kraih commented Apr 28, 2020

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

@kraih
Copy link
Member Author

kraih commented Apr 28, 2020

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.

@codecov
Copy link

codecov bot commented Apr 28, 2020

Codecov Report

Merging #3009 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
lib/OpenQA/Worker/CommandHandler.pm 93.75% <0.00%> (+1.56%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 647c61d...901ee2b. Read the comment docs.

@kraih kraih force-pushed the kraih/client_docs branch 4 times, most recently from cf7038a to c1ceda1 Compare April 29, 2020 10:07
@kraih kraih changed the title [WIP] Add openqa-cli documentation Add openqa-cli documentation Apr 29, 2020
@kraih kraih marked this pull request as ready for review April 29, 2020 10:13

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
Copy link
Member

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.

Copy link
Member Author

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. 😉

docs/Client.asciidoc Outdated Show resolved Hide resolved
docs/Client.asciidoc Show resolved Hide resolved
@kraih kraih force-pushed the kraih/client_docs branch 2 times, most recently from a3314c0 to 6e91513 Compare April 29, 2020 15:20
Copy link
Member

@okurz okurz left a 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. :)

docs/Client.asciidoc Outdated Show resolved Hide resolved
docs/Client.asciidoc Outdated Show resolved Hide resolved
@kraih kraih force-pushed the kraih/client_docs branch 2 times, most recently from 901ee2b to aced943 Compare April 30, 2020 09:58
@kraih kraih merged commit 87a79be into master Apr 30, 2020
@kraih kraih deleted the kraih/client_docs branch May 4, 2020 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants