1 <?xml version="1.0" encoding="UTF-8"?>
2 <appendix xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
3 xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="app_community_support">
4 <?dbhtml stop-chunking?>
5 <title>Community support</title>
6 <para>Many resources are available to help you run and use OpenDaylight. Members of the
7 OpenDaylight community can answer questions and help with bug suspicions. We are constantly
8 improving and adding to the main features of OpenDaylight, but if you have any problems, do
9 not hesitate to ask. Use the following resources to get OpenDaylight support and
10 troubleshoot your existing installations.</para>
11 <section xml:id="app_community_support-documentation">
12 <title>Documentation</title>
13 <para>For the available OpenDaylight documentation, see <link
14 xlink:href="http://docs.openstack.org">docs.opendaylight.org</link>.</para>
15 <para>The following books explain how to install and operate OpenDaylight SDN Controller: </para>
20 xlink:href="http://docs.openstack.org/trunk/install-guide/install/apt-debian/content/"
21 ><citetitle>Installation Guide</citetitle></link>
26 <link xlink:href="http://docs.openstack.org/user-guide/content/"><citetitle>End
27 User Guide</citetitle></link>
32 <link xlink:href="http://docs.openstack.org/cli-reference/content/"
33 ><citetitle>Command Line Interface Reference</citetitle></link>
37 <para>The following documentation provides reference and guidance information for the
38 OpenStack APIs:</para>
41 <para><link xlink:href="http://api.openstack.org/api-ref.html">OpenDaylight API
42 Reference</link></para>
46 <section xml:id="app_community_support-mailing-lists">
47 <title>OpenDaylight mailing lists</title>
48 <para>A great way to get answers and insights is to post your question or problematic
49 scenario to the OpenStack mailing list. You can learn from and help others who might
50 have similar issues. To subscribe or view the archives, go to <link
51 xlink:href="https://lists.opendaylight.org/mailman/listinfo"
52 >https://lists.opendaylight.org/mailman/listinfo</link>. You might be interested in
53 the other mailing lists for specific projects or development, which you can find <link
54 xlink:href="https://lists.opendaylight.org/mailman/listinfo">on the wiki</link>.
57 <section xml:id="app_community_support-wiki">
58 <title>The OpenDaylight wiki</title>
59 <para>The <link xlink:href="https://wiki.opendaylight.org/view/Main_Page">OpenDaylight
60 wiki</link> contains a broad range of topics but some of the information can be
61 difficult to find or is a few pages deep. Fortunately, the wiki search feature enables
62 you to search by title or content. If you search for specific information, such as about
63 networking or nova, you can find lots of relevant material. More is being added all the
64 time, so be sure to check back often. You can find the search box in the upper right
65 corner of any OpenDaylight wiki page.</para>
67 <section xml:id="app_community_support-bugs-area">
68 <title>Bugzilla Bugs</title>
69 <para>The OpenDaylight community values your set up and testing efforts and wants your
70 feedback. To log a bug, you must sign up for an OpenDaylight account at <link
71 xlink:href="https://launchpad.net/+login">https://launchpad.net/+login</link>. You
72 can view existing bugs and report bugs in the Bugzilla bug tracker at <link
73 xlink:href="https://bugs.opendaylight.org/"/>. Use the search feature to determine
74 whether the bug has already been reported or even better, already fixed. If it still
75 seems like your bug is unreported, fill out a bug report.</para>
76 <para>Some tips:</para>
79 <para>Give a clear, concise summary!</para>
82 <para>Provide as much detail as possible in the description. Paste in your command
83 output or stack traces, links to screen shots, and so on.</para>
86 <para>Be sure to include the software and package versions that you are using,
87 especially if you are using a development branch, such as, <literal>"Hydrogen
88 release" vs git commit
89 bc79c3ecc55929bac585d04a03475b72e06a3208</literal>.</para>
92 <para>Any deployment specific information is helpful, such as Ubuntu 12.04 or
93 multi-node install.</para>
97 <section xml:id="app_support-irc_channel">
98 <title>The OpenDaylight IRC channel</title>
99 <para>The OpenDaylight community is usually available in the #opendaylight IRC channel on
100 the Freenode network. You can hang out, ask questions, or get immediate feedback for
101 urgent and pressing issues. To install an IRC client or use a browser-based client, go
102 to <link xlink:href="http://webchat.freenode.net">http://webchat.freenode.net/</link>.
103 You can also use Colloquy (Mac OS X, <link xlink:href="http://colloquy.info/"
104 >http://colloquy.info/</link>), mIRC (Windows, <link
105 xlink:href="http://www.mirc.com/">http://www.mirc.com/</link>), or XChat (Linux).
106 When you are in the IRC channel and want to share code or command output, the generally
107 accepted method is to use a Paste Bin. </para>