Skip to content

fix: rename agent/master comm doc to agent/server, modernize content and diagram#256

Draft
miharp wants to merge 3 commits into
OpenVoxProject:masterfrom
miharp:fix/agent-server-comm-terminology
Draft

fix: rename agent/master comm doc to agent/server, modernize content and diagram#256
miharp wants to merge 3 commits into
OpenVoxProject:masterfrom
miharp:fix/agent-server-comm-terminology

Conversation

@miharp
Copy link
Copy Markdown
Contributor

@miharp miharp commented May 27, 2026

Summary

  • Rename subsystem_agent_master_comm.markdownsubsystem_agent_server_comm.markdown and update all inbound links (nav, architecture.markdown, ssl_attributes_extensions.markdown)
  • Rewrite page content adopting the current Puppet docs structure: single numbered flow (steps 1–6), accurate cert acquisition steps (CA bundle, CRL, CSR with dns_alt_names/csr_attributes, waitforcert behavior), cleaner keep-alive section
  • Replace outdated Puppet 3.x GIF diagram with a Mermaid sequence diagram; remove old GIF files
  • Add Mermaid rendering support to head_end.html (CDN module import, Turbo + window.load event handling)
  • Pin Mermaid to 11.15.0 in both the CDN URL and a new package.json; add npm ecosystem to Dependabot so version bump PRs are raised automatically
  • Clean markdownlint violations in ssl_attributes_extensions.markdown (touched file)

Test plan

  • Jekyll build passes
  • Mermaid diagram renders correctly on the agent/server HTTPS communications page
  • Nav link resolves to the renamed page
  • Inbound links from architecture.markdown and ssl_attributes_extensions.markdown resolve correctly in built output

Part of #223

miharp added 2 commits May 27, 2026 08:03
- Rename subsystem_agent_master_comm.markdown to subsystem_agent_server_comm.markdown
- Rewrite content to adopt Puppet docs structure: single numbered flow (steps
  1-6), updated cert acquisition steps (CRL, CSR with dns_alt_names/csr_attributes,
  waitforcert behavior), cleaner keep-alive section, accurate intro
- Replace outdated GIF diagram with Mermaid sequence diagram; remove old GIF files
- Add Mermaid rendering support to head_end.html (CDN, pinned to 11.15.0)
- Add package.json and Dependabot npm tracking for Mermaid version management
- Update inbound links in architecture.markdown, ssl_attributes_extensions.markdown,
  and nav file; drop unnecessary ./ prefix per CONTRIBUTING.md link rules

Signed-off-by: Michael Harp <mike@mikeharp.com>
File was touched to update link text; per project convention, clean all
violations in the changed file: wrap long lines (MD013), add language
identifiers to fenced code blocks (MD040), suppress false-positive emphasis
warning around Liquid include tag (MD037), and drop unnecessary ./ prefixes
from link reference definitions per CONTRIBUTING.md linking rules.

Signed-off-by: Michael Harp <mike@mikeharp.com>
@miharp miharp force-pushed the fix/agent-server-comm-terminology branch from 770c7f7 to b1de12a Compare May 27, 2026 12:03
File was touched to update link URL; per project convention, clean all
violations in the changed file: wrap long lines (MD013), add blank lines
around headings (MD022), fix unused/undefined reference definitions
(MD053/MD052), drop unnecessary ./ prefixes per CONTRIBUTING.md linking
rules, and remove unused Kramdown IAL annotations ({:.concept}/{:.section})
that have no effect in the current theme.

Signed-off-by: Michael Harp <mike@mikeharp.com>
@binford2k
Copy link
Copy Markdown
Contributor

Yay mermaid! 🧜‍♀️

@OpenVoxProject/sig-documentation we are going to need to decide whether we're doing sembr and if so, what variant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants