Repository: jclouds-site Updated Branches: refs/heads/master 6c77967b8 -> b558b9577
Reformatted the bug reporting guidelines page Project: http://git-wip-us.apache.org/repos/asf/jclouds-site/repo Commit: http://git-wip-us.apache.org/repos/asf/jclouds-site/commit/b558b957 Tree: http://git-wip-us.apache.org/repos/asf/jclouds-site/tree/b558b957 Diff: http://git-wip-us.apache.org/repos/asf/jclouds-site/diff/b558b957 Branch: refs/heads/master Commit: b558b9577cdd581e65fd450182aae64556c47017 Parents: 6c77967 Author: Ignasi Barrera <[email protected]> Authored: Fri Jan 12 09:29:21 2018 +0100 Committer: Ignasi Barrera <[email protected]> Committed: Fri Jan 12 09:29:21 2018 +0100 ---------------------------------------------------------------------- reference/report-a-bug.md | 74 ++++++++++++++++++++---------------------- start/install.md | 9 +++-- 2 files changed, 42 insertions(+), 41 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/jclouds-site/blob/b558b957/reference/report-a-bug.md ---------------------------------------------------------------------- diff --git a/reference/report-a-bug.md b/reference/report-a-bug.md index fe37449..9b1fb92 100644 --- a/reference/report-a-bug.md +++ b/reference/report-a-bug.md @@ -8,52 +8,50 @@ If you run into a bug while using jclouds, we encourage you to report it. To hel Bugs can be reported in [JIRA](https://issues.apache.org/jira/browse/JCLOUDS) or via the [jclouds user mailing list](/community/). -1. [jclouds Version](#jclouds-version) -1. [Cloud and API Version](#cloud-version) -1. [Operating System Version](#os-version) -1. [Java Version](#java-version) -1. [Logs](#logs) -1. [Code](#code) -1. [Documentation](#doc) - -## <a id="jclouds-version"></a>jclouds Version - -The version of jclouds can be found in the name of the JAR files you are using in your application or the pom.xml file of your application if you're using Maven. - -e.g. jclouds Version: 1.7.1 - -## <a id="cloud-version"></a>Cloud and API Version - -If you are using a private cloud such as OpenStack, CloudStack, or vCloud, you might be able to report the Cloud and API version. - -e.g. Cloud and API Version: OpenStack Havana, Cinder API v2 - -## <a id="os-version"></a>Operating System Version - -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_51" - -## <a id="logs"></a>Logs +When possible, try to include the following information in the bug report: + +<table class="table table-striped table-hover"> +<tbody> +<tr> + <td><strong>jclouds version</strong></td> + <td>The version of jclouds can be found in the name of the JAR files you are using in your application or the pom.xml file of your application if you're using Maven.<br/> + <em>e.g. 1.7.1</em></td> +</tr> +<tr> + <td><strong>Provider or API version</strong></td> + <td>If you are using a private cloud such as OpenStack, CloudStack, or vCloud, you might be able to report the Cloud and API version.<br/> + <em>e.g. Cloud and API Version: OpenStack Havana, Cinder API v2</em></td> +</tr> +<tr> + <td><strong>Operating system</strong></td> + <td>The Operating System Version you're using.<br/> + <em>e.g. Operating System Version: Mac OS X 10.7.5</em></td> +</tr> +<tr> + <td><strong>Java version</strong></td> + <td>The Java version you're using.<br/> + <em>e.g. "1.7.0_51"</em></td> +</tr> +</tbody> +</table> + +<div class="alert alert-danger"> +<span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span> +Please remember to <strong>remove all credentials and other sensitive information</strong> from anything you share! +</div> + +## <a id="logs"></a>Collecting 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. Please read [Logging](/reference/logging/) to install, configure, and enable logging. -If you are reporting the bug in JIRA, you can simply attach the jclouds-wire.log and other logs to the issue. If you are sending the report to the user mailing list, please put the logs into a [gist](https://gist.github.com/) or [pastie](http://pastie.org/) and include the link in the email. +If you are reporting the bug in JIRA, you can simply attach the `jclouds-wire.log` and other logs to the issue. If you are sending the report to the user mailing list, please put the logs into a [gist](https://gist.github.com/) or [pastie](http://pastie.org/) and include the link in the email. -## <a id="code"></a>Code +## <a id="code"></a>Providing relevant code If you can isolate the problem within a single Java file, send us that file so we can attempt to immediately reproduce the error. If you can't isolate the problem, send us as large a code snippet as possible around the problem code. If you are reporting the bug in JIRA, you can simply attach the code to the issue. If you are sending the report to the user mailing list, please put the code into a [gist](https://gist.github.com/) or [pastie](http://pastie.org/) and include the link in the email. -Please remember to __remove all credentials and other sensitive information__ from anything you share! - -## <a id="doc"></a>Documentation +## <a id="doc"></a>Reporting documentation issues If you find a bug in the documentation, you can report that via JIRA or the user mailing list too. However it is quite easy to fix the documentation (this website) and we encourage you to do so by reading [How to Contribute Documentation](https://cwiki.apache.org/confluence/display/JCLOUDS/How+to+Contribute+Documentation). http://git-wip-us.apache.org/repos/asf/jclouds-site/blob/b558b957/start/install.md ---------------------------------------------------------------------- diff --git a/start/install.md b/start/install.md index 70501cd..a04727b 100644 --- a/start/install.md +++ b/start/install.md @@ -44,7 +44,8 @@ If you do not have a *pom.xml* file, you can copy and paste the one below. If yo ###Â Using the daily builds <div class="alert alert-danger"> -<strong>Warning!</strong> These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation. +<span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span> +These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation. </div> If you want to use the bleeding edge release of jclouds, you'll need to setup a maven dependency pointing to our snapshot repository. You need to update your repositories and add the following in your project's pom.xml: @@ -93,7 +94,8 @@ You can add jclouds to your *project.clj* like below, supporting clojure 1.2 and ### Using the daily builds <div class="alert alert-danger"> -<strong>Warning!</strong> These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation. +<span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span> +These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation. </div> You can add jclouds snapshots to your *project.clj* like below: @@ -136,7 +138,8 @@ Then, add jclouds to your *build.xml* as shown below: ### Using the daily builds <div class="alert alert-danger"> -<strong>Warning!</strong> These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation. +<span class="glyphicon glyphicon-exclamation-sign" aria-hidden="true"></span> +These are untested snapshot builds provided for convenience; they are not official releases of the Apache jclouds project, or the Apache Software Foundation. </div> You will need to install [maven ant tasks](http://maven.apache.org/ant-tasks/index.html). Then, add jclouds snapshot dependencies to your *build.xml* as shown below:
