Documentation Nexus IQ Server 1.33

Our documentation site has moved. For the most current version, please see http://help.sonatype.com

Chapter 1. How to Use This Book

This book is the first source of knowledge for using the different components of Nexus Lifecycle and Nexus Auditor. To get the most out of the various chapters and sections, as well as help familiarize yourself with how the book has been organized, take a look at the topics below.

Section Navigation
For all intents and purposes, our documentation is presented as a book with various chapters and sections. The navigation bar on the left-hand side of the documentation allows you to access specific chapters directly, while clicking on TOC (located at the top of any section) will display all chapters. Click Next or Previous (located at the top or bottom of each page) to cycle forwards or backwards through the book.
Search
Documentation for the latest release version of IQ has a search input box at the top right-hand side of the page that accesses relevant sections and pages by search term. This documentation feature is not available for previous release versions.
Interface Highlighting
When referencing a specific part of the user interface (e.g. a label or button). This will be highlighted by italics. E.g. "Click the New Organization button to create a new organization."
Code Segments

A code segment or command line input in a paragraph would be looking like this mvn clean install.

Larger code segments are encapsulated in a block:

$tar xfvz nexus-iq-server-1.33.0-04-bundle.tar.gz
x nexus-iq-server-1.33.0-04.jar
x demo.sh
x config.yml
x eula.html
x demo.bat
x README.txt
Callouts

The documentation uses specific callout blocks for notes, tips and important images:

[Note]

You can download Java from the Oracle website.

[Tip]

The IQ Server should be set up to run as a service.

[Important]

IQ Server requires Java 7.

In addition there are blocks for warnings and cautioning alerts:

[Warning]

Importing a policy will erase existing policies.

[Caution]

Upgrading components might require you to refactor your codebase.

Screenshots
Application screenshots and other images are typically included as numbered figures and referenced from the flowing text.