How to Report Issues in Arvados » History » Version 1

Brett Smith, 09/18/2014 09:30 AM
first draft, not final

1 1 Brett Smith
h1. How to Report Issues in Arvados
2 1 Brett Smith
3 1 Brett Smith
If you encounter a problem using Arvados, the surest way to make sure it gets fixed is to "report an issue on our bug tracker":  The best bug reports include:
4 1 Brett Smith
5 1 Brett Smith
* all the steps you took that led to the issue,
6 1 Brett Smith
* the action Arvados took, including the full text of any error messages it reported, and
7 1 Brett Smith
* the action you expected Arvados to take (even if that's as simple as "it shouldn't crash").
8 1 Brett Smith
9 1 Brett Smith
Some issues are limited to specific data in Arvados—for example, maybe you're having trouble accessing a particular collection.  When you file issues like this, please *only include UUIDs for jobs, pipeline instances, and pipeline templates*.  Other identifiers, like Collection UUIDs or Keep block locators, can potentially reveal details about your work to the public.  If you're having trouble with sensitive data, please refer to it through data that's safe to talk about—for example, "the input parameter of pipeline instance P," or "the output of job J."  If you're including a large error message like a backtrace from a command-line tool, please take care to edit out any sensitive identifiers in it.
10 1 Brett Smith
11 1 Brett Smith
If you must report an issue that includes sensitive information, please send it by e-mail to  Thanks for helping us improve Arvados!