This repository contains the documentation website for the Java Operator SDK (JOSDK), built using Hugo and the Docsy theme.

Java Operator SDK is a framework that makes it easy to build Kubernetes operators in Java. It provides APIs designed to feel natural to Java developers and handles common operator challenges automatically, allowing you to focus on your business logic.

This documentation site uses Hugo v0.125.7 with the Docsy theme.

• Hugo v0.125.7 or later (extended version required)
• Node.js and npm (for PostCSS processing)
• Git

1. Clone this repository
2. Install dependencies:

   npm install

3. Start the development server:

   hugo server

4. Open your browser to http://localhost:1313

You can also run the documentation site using Docker:

1. Build the container:

   docker-compose build

2. Run the container:

   docker-compose up

   Note: You can combine both commands with docker-compose up --build

3. Access the site at http://localhost:1313

To stop the container, press Ctrl + C in your terminal.

To clean up Docker resources:

docker-compose rm

We welcome contributions to improve the documentation! Please see our contribution guidelines for details on how to get started.

If you see an error about module compatibility, ensure you're using Hugo v0.110.0 or higher:

Error: Error building site: failed to extract shortcode: template for shortcode "blocks/cover" not found

If you encounter SCSS-related errors, make sure you have the extended version of Hugo installed:

Error: TOCSS: failed to transform "scss/main.scss"

If you see "binary with name 'go' not found", install the Go programming language from golang.org.

• Hugo Documentation
• Docsy Theme Documentation
• Java Operator SDK GitHub Repository