introduction-to-documentation.html

---
# Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
title: "Documentation Conventions"
redirect_from:
- /documentation/introduction-to-documentation.html
---

<p>
  This documentation is for users of Vespa, or potential users -
  being application owners / PMs, engineers or operators.
  The documentation covers conceptual overviews of the product,
  including background theory and explanations of why the product has developed along the lines it has.
  This is followed by deeper investigation of the features that developers will use first.
</p>
<p>
  For Vespa plugin development, the documentation is aimed at experienced Java developers.
  It is not aimed at beginners and does not cover general programming techniques
  or the basics of programming languages.
</p>
<p>
  For parts of the documentation the reader should be familiar with Unix-like platforms,
  as Vespa is available on Linux.
  The exposure of Vespa's APIs is such that the user does not need in-depth knowledge
  about how Vespa's inner workings in order to start using it.
  The reader does not have to be an expert by any means,
  but the text and samples become easier to follow
  as Vespa's principles are more properly understood.
</p>
<p>
  If you find errors, spelling mistakes, faulty pieces of code
  or want to improve the documentation,
  please submit a pull request or <a href="https://github.com/vespa-engine/vespa/issues">create an issue</a>.
</p>
<p>
  <em>Italic</em> is used for:
</p>
<ul>
  <li>Pathnames, filenames, program names, hostnames, and URLs</li>
  <li>New terms where they are defined</li>
</ul>
<p>
  <code>Constant Width</code> is used for:
</p>
<ul>
  <li>Programming language elements, code examples, keywords, functions,
    classes, interfaces, methods, etc.</li>
  <li>Commands and command-line output</li>
</ul>
<p>
Commands meant to be run on the command line are shown like this,
prepended by a $ for the prompt:
</p>
<pre>
$ export PATH=$VESPA_HOME/bin:$PATH   # <span class="pre-hilite">how to highlight text in &lt;pre&gt;</span>
</pre>
<p>
  Notes and other Important pieces of information are shown like:
</p>
{% include note.html       content="Some info here"%}
{% include important.html  content="Important info here"%}
{% include warning.html    content="Warning here"%}
{% include deprecated.html content="Deprecation warning here"%}