Skip to main content

How to Read the Docs

Intended audience: Data Teams, Platform Teams

Witboost’s documentation is organized around who you are and what you want to achieve.

That's why we have two main sections: one for Data Teams and one for Platform Teams. Each section is further divided into focus areas such as Control Plane, Market Plane and so on. Each focus area could be then divided, but not always, into four purposes: Tutorials, How-to guides, Reference, and Explanation.

In this page, we explain how to read the documentation and find the information you need based on your goals.

Who are you ?​

There are two main audiences:

  • Data Teams: who use Witboost to build, deliver, and operate products.
  • 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 products using Witboost.

You’ll learn how to:

  • Understand the Witboost concepts: projects vs products, components, policies, and templates.
  • Use Witboost to build and deliver products by creating projects.
  • Work with templates and blueprints to create projects and components that already follow your organization’s best practices.
  • Integrate with the CLI to automate operations.

For Platform Teams​

Platform Teams are responsible for running the platform, integrating your organization's technologies, and enabling Data Teams to deliver value quickly and with best practices embedded.

You’ll learn how to:

  • Deploy and configure Witboost in your environment.
  • Manage authentication, authorization, and platform configurations.
  • Collaborate with Governance Teams to define and enforce computational policies.
  • Integrate with your organization's technologies with tech adapters, templates, blueprints, and more.
  • Embed your organization's operational model with the Practice Shaper.
  • Extend the platform with new capabilities through extension points.

Your starting point is the For Platform Teams section.

tip

An effective Platform Team 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.

What do you want to achieve ?​

The content of this documentation follows a precise structure, inspired by the Divio documentation system, that helps you find the information you need based on your goals. Documentation can serve four distinct purposes, and each one is organized in its own dedicated section.

Not every article will belong to a section; some articles may be relevant to multiple purposes or presented as top-level articles like this one that you are reading.

Tutorials​

Learning-oriented: a step-by-step lesson that guides you through completing a meaningful exercise from start to finish.

Read a tutorial when you are new to Witboost and want to learn by doing. Tutorials are designed to build your confidence and give you a first working result, not to explain every detail along the way.

How-to guides​

Goal-oriented: a set of directions that guide you through the steps required to solve a specific, real-world problem.

Read a how-to guide when you already know the basics and need to achieve a particular task, such as configuring a specific integration or performing an operation.

Reference​

Information-oriented: technical descriptions of Witboost's components, APIs, configuration options, and CLI commands.

Read the reference documentation when you need precise, factual information about how something works, such as the exact parameters of a configuration file or an API endpoint.

Explanation​

Understanding-oriented: articles that clarify and provide context around a topic, discussing the reasoning, concepts, and background behind it.

Read the explanation documentation when you want to deepen your understanding of Witboost's architecture and design choices, rather than perform a specific action.

Other sections​

  • API: a dedicated section for the Witboost APIs, which are used to extend the platform with new capabilities or to automate operations via REST APIs.
  • CLI: a dedicated section for the Witboost CLI, which is used to interact with the platform and automate operations.
  • Releases: a dedicated section for the Witboost release notes, which provide information about new features, bug fixes, and other changes in each release.
  • Installation: a dedicated section for the Witboost installation and upgrade guides, which provide information about how to install and upgrade the platform in your environment.
  • Tutorials: Video tutorials that provide a visual and interactive way to learn about Witboost's features and capabilities.