Refactor preface

Mark Craig

26.48.2012 dc7867fe42ad33798243691a9ccbca5fec6c0fe8

 opendj3/src/main/docbkx/admin-guide/preface.xml

@@ -60,98 +60,7 @@
  started with this guide, and then learn more as you go along.</para>
 </section>

 <section>
  <title>Using Samples</title>

  <para>This work is licensed under the <link
  xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0/"
  >Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
  License</link>.</para>

  <para>See the license for the specific language governing permissions and
  limitations under the license.</para>
 </section>

 <section>
  <title>Formatting Conventions</title>

  <note><para>Pay attention to notes like this one.</para></note>

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

  <programlisting language='java'>class Test
{
    public static void main(String [] args)
    {
        System.out.println("This is a program listing.");
    }
}</programlisting>

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
  directory names are often given only in UNIX format as in
  <filename>/path/to/OpenDJ</filename>, even if the text applies to
  <filename>C:\path\to\OpenDJ</filename> as well.</para>

  <warning><para>Ignore warnings at your own risk.</para></warning>
 </section>

 <section>
  <title>Accessing OpenDJ Documentation Online</title>

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
  xlink:href='https://wikis.forgerock.org/confluence/display/devcom/Review+Process'
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>

  <para>The <link xlink:show="new"
  xlink:href="https://wikis.forgerock.org/confluence/display/OPENDJ">OpenDJ
  Wiki</link> regularly brings you more, fresh content. In addition, you are
  welcome to <link xlink:show="new"
  xlink:href="https://idp.forgerock.org/openam/UI/Login?service=register">sign
  up</link> and then edit the Wiki if you notice an error, or if you have
  something to share.</para>
 </section>

 <section>
  <title>Joining the OpenDJ Community</title>

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/get_involved.html'>
  how to get involved</link>.</para>
 </section>

 <xinclude:include href="../shared/sec-formatting-conventions.xml" />
 <xinclude:include href="../shared/sec-accessing-doc-online.xml" />
 <xinclude:include href="../shared/sec-joining-the-community.xml" />
</preface>