Skip to content

docs: fix stale references and mental models in development.md#178

Merged
mrhillsman merged 5 commits into
mainfrom
docs/development-stale-references-177
Jun 1, 2026
Merged

docs: fix stale references and mental models in development.md#178
mrhillsman merged 5 commits into
mainfrom
docs/development-stale-references-177

Conversation

@mrhillsman

Copy link
Copy Markdown
Contributor

Summary

  • Update Go prerequisite from 1.25+ to 1.26+ to match go.mod
  • Add missing orchestrator/ package to project structure listing
  • Fix architecture layers table: move audit to Layer 1, add orchestrator to Layer 4
  • Fix DataVolumeTemplates() signature to show error return; remove phantom namespace param from ServiceSpec()
  • Replace stale Roles() []string with RoleDistribution() []RoleSpec in MultiVMWorkload interface listing and pattern instructions
  • Fix NamespaceDataVolumes path to internal/orchestrator/types.go and update concurrency narrative to reference orchestrator package

Resolves #177

Update Go prerequisite from 1.25+ to 1.26+ to match go.mod.
Add missing orchestrator/ package to project layout listing.

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Move audit from Layer 4 to Layer 1 (recording, not orchestration).
Add orchestrator to Layer 4 where errgroup concurrency lives.

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
…table

DataVolumeTemplates returns ([]DataVolumeTemplateSpec, error), not just nil.
ServiceSpec takes no namespace parameter — the actual signature is
ServiceSpec() *corev1.Service.

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
Replace stale Roles() []string with RoleDistribution() []RoleSpec.
Include RoleSpec type definition showing Role and VMCount fields.
Rewrite pattern steps to explain per-role VM counts instead of
len(Roles()) multiplication.

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
NamespaceDataVolumes is exported and lives in
internal/orchestrator/types.go, not in cmd/virtwork/main.go.
Concurrency narrative now correctly attributes errgroup usage to
the orchestrator package.

Signed-off-by: Melvin Hillsman <mhillsma@redhat.com>
@exe-prow-github-app
exe-prow-github-app Bot requested a review from OchiengEd June 1, 2026 18:19
@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 1, 2026
@mrhillsman
mrhillsman removed the request for review from OchiengEd June 1, 2026 18:20
@mrhillsman
mrhillsman merged commit 091dc68 into main Jun 1, 2026
3 of 4 checks passed
@mrhillsman
mrhillsman deleted the docs/development-stale-references-177 branch June 1, 2026 18:28
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.

[Docs]: development.md stale references and incorrect mental models

1 participant