Multi-Project Support

ubTrace is designed to support multiple projects in parallel. The main goal is to provide a centralized platform for all necessary documentation.

Projects can be structured by:

• Organization name: A simple identifier for a team or company.

• Project name: The name of the project itself.

• Version: A specific version of the project documentation.

The Organization name allows multiple teams to operate under a single ubTrace instance, accessible via a single domain, such as docs.my-company.com.

The Project name enables splitting large and complex documentation projects into smaller, manageable pieces. For example, the documentation for a complex automotive software project could be divided into: System docs, Component A docs, Component B docs, and Software User Guide. ubTrace features and extensions like Sphinx-Needs ensure proper linking between these documentation parts.

Version is used to store different versions of documentation. A common use case is release-specific documentation deployments, ensuring that documentation for older releases remains available. This prevents confusion caused by newer information that may not be applicable to the software version in use.

Multi-Project selection form

The Multi-Project support can be activated in the server configuration of ubTrace. For details, see Server Options.

Search Support

The search feature of ubTrace supports searching across multiple projects in a single query.