Sonatype CLM - Document Descriptions and PDFs

Chapter 2. Documentation Usage Guide

The Sonatype CLM documentation you are reading right now is first source of knowledge about using all the different components of the Sonatype CLM suite of tools and applications. It is separated into a number of different guides, all of which are available in HTML and PDF format.

The navigation bar on the left-hand side of the documentation allows you to access all the different guides directly.

The top right-hand side of the documentation features a search input box that accesses all guides and documents to provide you with the relevant document for your search term.

A user interface label or button is highlighted. E.g. use the Applications button to access the list of applications in the CLM server.

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 sonatype-clm-server-1.12.0-bundle.tar.gz
x sonatype-clm-server-1.12.0.jar
x demo.sh
x config.yml
x eula.html
x demo.bat
x README.txt

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

[Note]

You can download Java from the Oracle website.

[Tip]

The CLM server should be set up to run as a service.

[Important]

CLM 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.

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