Workflows

Guides

Practical implementation paths for adopting Helix conventions across services and platform code.

Helix guides work best when teams move from setup, to standardization, to rollout. These are the most common paths through the ecosystem.

Bootstrap a New Service

Start with the standard path for evaluating Helix in a real project.

  • Install the CLI and local toolchain
  • Generate a project from a supported template
  • Run the default Gradle workflow

Standardize Build Conventions

Use Helix plugins to reduce drift between repositories and services.

  • Apply shared quality and publishing defaults
  • Adopt locking, dependency, and security conventions
  • Keep project structure aligned across teams

Adopt Platform Modules

Expand from templates into reusable libraries and starter-backed capabilities.

  • Choose shared modules for API, data, and operations
  • Use starter modules when Spring Boot integration is needed
  • Link implementation choices back to the reference docs

Roll Out Across Multiple Services

Turn documentation into a repeatable adoption model instead of a one-off setup.

  • Start with one or two reference services
  • Document the approved template and plugin baseline
  • Use examples and FAQs to support broader adoption

Suggested Reading