#191 User Documentation
Merged by lholecek. Opened by lholecek.
lholecek/waiverdb user-docs  into  master

Download 191.patch

Any ideas what could be added? Additional information about authentication, configuration, env variables?

More examples? Some real queries?

Fixes #149

Mmm I would not say to use curl... I think if someone knows how to use curl they know how to use a rest-api... Maybe also put a link to the doc: https://pagure.io/docs/waiverdb/ --> API

We can write something about the authentication. The different types and how to configure it.

But in general :+1:

Should mention that these options are only needed if the auth_method is OIDC. That may not be obvious to some people.

Can you add a section to the user-guide with examples? Specifically, one example of waiving a result given its ID, and a second example of waiving a result by specifying a testcase name and item, etc.

I can remove the curl stuff.

This documentation page is at https://pagure.io/docs/waiverdb/. I don't think the URL requires mentioning since the reader will already be there.

Can you add a section to the user-guide with examples? Specifically, one example of waiving a result given its ID, and a second example of waiving a result by specifying a testcase name and item, etc.

Examples added. Though those are same as mentioned on the man page linked from the page.

rebased onto 68b8264c3e15612cdb62f7696e859cc866c88e48

:+1:, thanks, and I didn't realize about the man page. :)

Pull-Request has been merged by lholecek

Metadata