docs: fix the socket example, procedure structure, terminology, front matter and links - #95
Merged
Merged
Conversation
… matter and links Installation - The machine-creation procedure gave 3100 as the example socket number. The configuration page says the Java Agent's SocketNumberToSAM defaults to 17100 and that the machine's socket number must match it, so a reader following the example created a machine the agent would not talk to. The step now says the value must match SocketNumberToSAM, which defaults to 17100. - The procedure's three parts were bold "Step 1", "Step 2" and "Step 3" labels with no lead-in sentences. They are now headings, each with a "To ..., complete the following steps:" lead-in. - Optional steps now start with "(Optional)", and menu paths bold each label rather than the whole path. - Installer wizard pages are referred to as steps and dialogs as windows, as the documentation standards require. Configuration file - The allowed-address example used a routable address; changed to 192.0.2.10, from a range reserved for documentation. - Two references to Enterprise Manager screens are reworded. Landing page - Added title, description and tags front matter, in the same shape as the other agent sites. The link menu is unchanged. Release notes - Added the marker legend used by the core OpCon release notes. The markers themselves are unchanged: they match the page as the release authors left it. Links - The two relative links without the .md extension now use it. Not changed here, because the pages cannot settle them: the JORS socket default (18110 in the table, 17110 in the example) and the Application Connector/Connection section name disagree within the configuration page, and the JAR operation and the 17.0.0 job-definition features appear only in the release notes. Co-Authored-By: Claude Opus 5.5 <[email protected]>
MoKranda
approved these changes
Sep 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes a socket-number example that contradicted the configuration reference, restructures
the machine-creation procedure, brings terminology and front matter in line with the
documentation standards, and adds the release-notes legend.
6 files, one commit. No product behavior is described here that the pages did not already
state.
Installation
3100as the example.The configuration page says the Java Agent's
SocketNumberToSAMdefaults to17100and that the machine's socket number must match it — so following the example produced
a machine the agent would not talk to. The step now says the value must match
SocketNumberToSAM, which defaults to17100.Step 3" labels with no lead-in. They are now headings, each with a "To …, complete the
following steps:" lead-in.
than the whole path; installer wizard pages are "steps" and dialogs are "windows".
Configuration file
192.0.2.10, from a rangereserved for documentation.
Landing page
Added
title,descriptionandtagsfront matter in the same shape as the other agentsites. The link menu is unchanged.
Release notes
Added the marker legend used by the core OpCon release notes. The markers are unchanged —
they match the page as the release authors left it.
Links
The two relative links without the
.mdextension now use it.Follow-ups for an owner
These need someone who knows the product; the pages cannot settle them.
JORSSocketa default of18110; the exampleAgent.configon the same page sets17110.[Application Connector Settings]; theexample calls it
[Application Connection Settings]. If the agent matches sectionnames, one of these is ignored.
LibrariesDirectoryalso appears asLibrariesin thetable and
librariesin the example.and the Alternate JVM field, JVM Arguments and Environment Variables tabs,
and
JAVA_ENV_VARS/JAVA_JVM_ARGS(17.0.0), but no page documents them. Theoverview lists three operation types while the machine-messages page describes
anything other than Class or Command as invalid.
"right-select" without giving an approved wording — open across all agent sites.
confirming.
Verification
.md.🤖 Generated with Claude Code