Skip to content

docs(guide): fix stale interface refs, code pointers, and mental models#173

Merged
mrhillsman merged 1 commit into
mainfrom
docs/guide-stale-references-172
Jun 1, 2026
Merged

docs(guide): fix stale interface refs, code pointers, and mental models#173
mrhillsman merged 1 commit into
mainfrom
docs/guide-stale-references-172

Conversation

@mrhillsman

Copy link
Copy Markdown
Contributor

Update guide files to match the current codebase:

  • Go prerequisite 1.25+ to 1.26+
  • DataVolumeTemplates() signature now returns ([], error)
  • Roles() → RoleDistribution() returning []RoleSpec throughout: complexity table, MultiVMWorkload prose, tutorial multi-VM section, mermaid diagram, and checklist
  • Orchestration flow now in internal/orchestrator/, not cmd/virtwork/main.go; split "Finding Your Way" table into orchestrator and CLI entry point rows
  • namespaceDataVolumes to NamespaceDataVolumes in internal/orchestrator/types.go
  • Step 4 "Register the Workload": remove stale AllWorkloadNames var editing (now a function derived from DefaultRegistry); update registry counts from 5 to 9

Resolves #172

Update guide files to match the current codebase:

- Go prerequisite 1.25+ → 1.26+
- DataVolumeTemplates() signature now returns ([], error)
- Roles() → RoleDistribution() returning []RoleSpec throughout:
  complexity table, MultiVMWorkload prose, tutorial multi-VM section,
  mermaid diagram, and checklist
- Orchestration flow now in internal/orchestrator/, not cmd/virtwork/main.go;
  split "Finding Your Way" table into orchestrator and CLI entry point rows
- namespaceDataVolumes → NamespaceDataVolumes in internal/orchestrator/types.go
- Step 4 "Register the Workload": remove stale AllWorkloadNames var editing
  (now a function derived from DefaultRegistry); update registry counts 5→9

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 17:10
@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 17:10
@mrhillsman mrhillsman merged commit bebe16f into main Jun 1, 2026
2 of 4 checks passed
@mrhillsman mrhillsman deleted the docs/guide-stale-references-172 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]: Guide files have stale interface references and incorrect code pointers

1 participant