Skip to main content

How to Read the Docs

Witboost’s documentation is organized around who you are and what you need to do within the platform.
There are two main audiences:

  • Data Teams → who use Witboost to build, deliver, and operate data projects.
  • Platform Teams → who run and extend Witboost to empower Data Teams.

For Data Teams​

This section is your starting point if your goal is to deliver value through data projects using Witboost.

You’ll learn how to:

  • Understand the Witboost concepts — domains, data projects, consumables, policies, metrics, and templates.
  • Use Witboost to build and deliver data projects.
  • Work with templates and blueprints to accelerate delivery.
  • Integrate with the CLI to automate operations.

👉 Navigate from the top bar to For Data Teams to find:

  • Concepts – the foundational ideas that structure the platform.
  • How-to Guides – step-by-step instructions for everyday tasks.
  • Tutorials – guided examples to help you learn by doing.

For Platform Teams​

If you manage, operate, or extend the Witboost platform, start here.
Platform Teams are responsible for running the platform, integrating components, and enabling Data Teams to succeed.

You’ll learn how to:

  • Deploy and configure Witboost in your environment.
  • Manage authentication, authorization, and configuration.
  • Create and maintain templates, blueprints, policies, and more.
  • Extend Witboost via the Extension Points API and Platform API.
  • Operate the platform lifecycle — upgrades, releases, and governance setup.

👉 Navigate from the top bar For Platform Teams.

note

Platform Teams should also be familiar with the For Data Teams section.
Understanding how Data Teams use Witboost is key to designing a platform experience that empowers them effectively.

Other sections​

Outside of these two core sections, the top navigation provides technical resources common to both audiences:

  • Extension Points API → interfaces for building and integrating new capabilities.
  • Platform API → endpoints to automate and interact programmatically with Witboost.
  • CLI → command-line interface to interact with the platform.
  • Releases → All Witboost releases and their migration notes.
  • Tutorials → guided walkthroughs to move the first steps into the Witboost platform.