You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jclouds.apache.org by Everett Toews <no...@github.com> on 2013/09/17 03:09:33 UTC

[jclouds-site] A guide on how to report a bug. (#18)

You can merge this Pull Request by running:

  git pull https://github.com/rackerlabs/jclouds-site bug-report

Or you can view, comment on it, or merge it online at:

  https://github.com/jclouds/jclouds-site/pull/18

-- Commit Summary --

  * A guide on how to report a bug.

-- File Changes --

    M documentation/jcloudsguides/index.md (1)
    A documentation/userguide/bug-report.md (97)

-- Patch Links --

https://github.com/jclouds/jclouds-site/pull/18.patch
https://github.com/jclouds/jclouds-site/pull/18.diff

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
> @@ -0,0 +1,97 @@
> +---
> +layout: jclouds
> +title: Documentation
> +---
> +
> +# How to Report a Bug to Apache jclouds&reg;
> +
> +If you run into a bug while using jclouds, we encourage you to report it. To help you please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.
> +
> +Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or the [jclouds user mailing list](mailto:user@jclouds.incubator.apache.org) ([subscribe](mailto:jclouds-user-subscribe@apache.org)).

>  I think it's okay to repeat them

Agree that they're unlikely to change. Was just commenting because in other places where we could have given the email address directly, we also link to the community page.

I guess giving people a gentle motivation to think about contributing is not a bad thing, but also OK to have the (fixed) email address here if you feel that's too annoying.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7647939

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
> +
> +The Operating System Version you're using.
> +
> +E.G. Operating System Version: Mac OS X 10.7.5
> +
> +## <a id="java-version"></a>Java Version
> +
> +The Java Version you're using.
> +
> +E.G. java version "1.7.0_17"
> +
> +## <a id="logs"></a>Logs
> +
> +Sending us the stack trace from the exception is helpful but often the root cause of the problem can be revealed by examining what's being sent over the wire.
> +
> +### Get Logging

Only partially agree here. The parts "Configure Logging" and "Enable Logging" below are very similar to what's listed under the SLF4J section in the "logging in jclouds" page. The design part only starts after that.

If we feel the "logging in jclouds" page could do with some additional info (e.g. about Maven deps), I'd certainly be all for improving it. But knowing how to configure jclouds logging in your app is useful not only if you need to report a bug - it's something that we should describe as part of using jclouds.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7648106

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
> @@ -0,0 +1,97 @@
> +---
> +layout: jclouds
> +title: Documentation
> +---
> +
> +# How to Report a Bug to Apache jclouds&reg;
> +
> +If you run into a bug while using jclouds, we encourage you to report it. To help you please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.
> +
> +Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or the [jclouds user mailing list](mailto:user@jclouds.incubator.apache.org) ([subscribe](mailto:jclouds-user-subscribe@apache.org)).
> +
> +1. [jclouds Version](#jclouds-version)
> +1. [Cloud and API Version](#cloud-version)

> We're used to throwing the term provider around but people new to cloud have no idea.

Ah...sorry, I think I was misreading this. You mean "Cloud [provider type/name]" and "[Cloud] API Version"? I was reading it as "Cloud Version" and "API Version".

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7648003

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
> @@ -0,0 +1,97 @@
> +---
> +layout: jclouds
> +title: Documentation
> +---
> +
> +# How to Report a Bug to Apache jclouds&reg;
> +
> +If you run into a bug while using jclouds, we encourage you to report it. To help you please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.
> +
> +Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or the [jclouds user mailing list](mailto:user@jclouds.incubator.apache.org) ([subscribe](mailto:jclouds-user-subscribe@apache.org)).

Rather than repeating the email addresses here, link to the [community page](http://jclouds.incubator.apache.org/documentation/community/)?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7235038

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Everett Toews <no...@github.com>.
> @@ -0,0 +1,97 @@
> +---
> +layout: jclouds
> +title: Documentation
> +---
> +
> +# How to Report a Bug to Apache jclouds&reg;
> +
> +If you run into a bug while using jclouds, we encourage you to report it. To help you please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.
> +
> +Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or the [jclouds user mailing list](mailto:user@jclouds.incubator.apache.org) ([subscribe](mailto:jclouds-user-subscribe@apache.org)).

Now that we're a TLP the addresses won't be changing. I think it's okay to repeat them because I'm saying you can report bugs to those lists not to necessarily anything on the community page. We need to go through all the docs and remove incubator references. So this will get fixed up then.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7643052

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Everett Toews <no...@github.com>.
Merged and deployed to site.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18#issuecomment-24640907

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
> @@ -0,0 +1,97 @@
> +---
> +layout: jclouds
> +title: Documentation
> +---
> +
> +# How to Report a Bug to Apache jclouds&reg;
> +
> +If you run into a bug while using jclouds, we encourage you to report it. To help you please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.
> +
> +Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or the [jclouds user mailing list](mailto:user@jclouds.incubator.apache.org) ([subscribe](mailto:jclouds-user-subscribe@apache.org)).
> +
> +1. [jclouds Version](#jclouds-version)
> +1. [Cloud and API Version](#cloud-version)

Should this be `Provider and API Version`? Or do we think users won't understand "Provider"?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7235034

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by CloudBees pull request builder plugin <no...@github.com>.
[jclouds-site-pull-requests #80](https://jclouds.ci.cloudbees.com/job/jclouds-site-pull-requests/80/) SUCCESS
This pull request looks good

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18#issuecomment-24557508

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Everett Toews <no...@github.com>.
Huh. I always thought e.g. should be caps if it starts a sentence/line. Just Googling around it looks like I'm wrong. I'll fix this.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18#issuecomment-28439378

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
General comment: s/E.G./e.g./?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18#issuecomment-27155668

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Everett Toews <no...@github.com>.
> +
> +The Operating System Version you're using.
> +
> +E.G. Operating System Version: Mac OS X 10.7.5
> +
> +## <a id="java-version"></a>Java Version
> +
> +The Java Version you're using.
> +
> +E.G. java version "1.7.0_17"
> +
> +## <a id="logs"></a>Logs
> +
> +Sending us the stack trace from the exception is helpful but often the root cause of the problem can be revealed by examining what's being sent over the wire.
> +
> +### Get Logging

That page is all about the design of logging in jclouds and not terribly helpful to someone who actually wants to do logging. This is a users only version of how to do logging.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7643113

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Andrew Phillips <no...@github.com>.
> +
> +The Operating System Version you're using.
> +
> +E.G. Operating System Version: Mac OS X 10.7.5
> +
> +## <a id="java-version"></a>Java Version
> +
> +The Java Version you're using.
> +
> +E.G. java version "1.7.0_17"
> +
> +## <a id="logs"></a>Logs
> +
> +Sending us the stack trace from the exception is helpful but often the root cause of the problem can be revealed by examining what's being sent over the wire.
> +
> +### Get Logging

Rather than potentially duplicating information, link to the [logging in jclouds page](http://jclouds.incubator.apache.org/documentation/reference/jclouds-logging/)?

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7235047

Re: [jclouds-site] A guide on how to report a bug. (#18)

Posted by Everett Toews <no...@github.com>.
> @@ -0,0 +1,97 @@
> +---
> +layout: jclouds
> +title: Documentation
> +---
> +
> +# How to Report a Bug to Apache jclouds&reg;
> +
> +If you run into a bug while using jclouds, we encourage you to report it. To help you please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.
> +
> +Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or the [jclouds user mailing list](mailto:user@jclouds.incubator.apache.org) ([subscribe](mailto:jclouds-user-subscribe@apache.org)).
> +
> +1. [jclouds Version](#jclouds-version)
> +1. [Cloud and API Version](#cloud-version)

Exactly. We're used to throwing the term provider around but people new to cloud have no idea.

---
Reply to this email directly or view it on GitHub:
https://github.com/jclouds/jclouds-site/pull/18/files#r7642960