The Vespa documentation (https://docs.vespa.ai/) provides all the information required to use all Vespa features and deploy them in any supported environment.
It is split into guides and tutorials, which explains features and how to use them to solve problems, and reference documentation which list complete information about all features and APIs.
The Vespa platform is open source, and can be deployed in self-managed systems and on the Vespa Cloud service. Some add-ons (but no core functionality) are only available under a commercial license.
Documents that describe functionality with such limited applicability are clearly marked by one or more of the following chips:
| Vespa Cloud This content is applicable to Vespa Cloud deployments. | Only applicable with Vespa Cloud deployments. |
| Self-managed This content is applicable to self-managed Vespa systems. | Only applicable with self-managed deployments. |
| Enterprise Not open source: This functionality is only available commercially. | Not open source: Available commercially only (both self-managed and on cloud unless also marked by one of the other chips above). |
For clarity, any document not marked with any of these chips describes functionality that is open source and available both on with Vespa Cloud and self-managed deployments.
If you find errors or want to improve the documentation, create an issue or contribute a fix. See the README before contributing.
Italic is used for:
Constant Width is used for:
Commands meant to be run on the command line are shown like this, prepended by a $ for the prompt:
$ export PATH=$VESPA_HOME/bin:$PATH # how to highlight text in <pre>
Notes and other Important pieces of information are shown like: