Skip to content

docs: update development guide for catalog workloads, storage, and services#198

Merged
mrhillsman merged 1 commit into
mainfrom
docs/update-development-guide
Jun 14, 2026
Merged

docs: update development guide for catalog workloads, storage, and services#198
mrhillsman merged 1 commit into
mainfrom
docs/update-development-guide

Conversation

@mrhillsman

Copy link
Copy Markdown
Contributor

Summary

  • Update DefaultRegistry() example to use current RegistryEntry{Factory, ParamSchema} pattern.
  • Add comprehensive "Adding a Catalog Workload" section covering directory layout, workload.yaml schema, single-role and multi-role entries, parameter substitution, storage-backed entries, service-backed entries, CLI flags, and orchestrator integration.
  • Add "Writing Tests for Workloads" section with Ginkgo examples for both built-in and catalog entry testing.
  • Refresh project layout tree descriptions for orchestrator and workloads packages.

Related-to #196

…rvices

Update DefaultRegistry() example to use current RegistryEntry{Factory,
ParamSchema} pattern. Add comprehensive "Adding a Catalog Workload"
section covering directory layout, workload.yaml schema, single-role
and multi-role entries, parameter substitution, storage-backed entries,
service-backed entries, CLI flags, and orchestrator integration. Add
"Writing Tests for Workloads" section with Ginkgo examples for both
built-in and catalog entry testing. Refresh project layout tree
descriptions for orchestrator and workloads packages.

Refs: #196

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
@exe-prow-github-app exe-prow-github-app Bot requested a review from OchiengEd June 14, 2026 01:26
@exe-prow-github-app

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrhillsman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@exe-prow-github-app exe-prow-github-app Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 14, 2026
@mrhillsman mrhillsman removed the request for review from OchiengEd June 14, 2026 01:26
@mrhillsman mrhillsman merged commit 18d437a into main Jun 14, 2026
3 of 4 checks passed
@mrhillsman mrhillsman deleted the docs/update-development-guide branch June 15, 2026 03:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant