Skip to content

Conversation

@corbob
Copy link
Member

@corbob corbob commented Jan 22, 2026

Description Of Changes

Update the configuration page to use xrefs instead of direct links.

Motivation and Context

See #1264

Testing

  • I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • Minor documentation fix (typos etc.).
  • Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • New documentation page added.
  • The change I have made should have a video added, and I have raised an issue for this.
    • Issue #

Change Checklist

  • Requires a change to menu structure (top or left-hand side)/
  • Menu structure has been updated
  • Images added to the img repository?
    • PR -

Related Issue

@gep13 gep13 requested a review from st3phhays January 27, 2026 10:24
@st3phhays
Copy link
Member

I will take this for a spin and add a review tomorrow.

Copy link
Member

@st3phhays st3phhays left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left one comment on a section of sections, but looking at the rest of the changes, I think we can apply the same concept to the other links/sections here as well. Let me know if you want to touch base on it!

Comment on lines +85 to 91
* `virusCheckMinimumPositives` = **'4'** - Minimum number of scan result positives before flagging a binary as a possible virus. Used when virusScannerType is VirusTotal. Licensed editions only. See <Xref title="Virus Check" value="virus-check" />.
* `virusScannerType` = **'VirusTotal'** - Virus Scanner Type (Generic or VirusTotal). Defaults to VirusTotal for Pro. Licensed editions only. See <Xref title="Virus Check" value="virus-check" />.
* `genericVirusScannerPath` = **' '** - The full path to the command line virus scanner executable. Used when virusScannerType is Generic. Licensed editions only. See <Xref title="Virus Check" value="virus-check" />.
* `genericVirusScannerArgs` = **'`[[File]]`'** - The arguments to pass to the generic virus scanner. Use `[[File]]` for the file path placeholder. Used when virusScannerType is Generic. Licensed editions only. See <Xref title="Virus Check" value="virus-check" />.
* `genericVirusScannerValidExitCodes` = **'0'** - The exit codes for the generic virus scanner when a file is not flagged. Separate with comma, defaults to 0. Used when virusScannerType is Generic. Licensed editions only. See <Xref title="Virus Check" value="virus-check" />.
* `genericVirusScannerTimeoutInSeconds` = **'120'** - Generic Virus Scanner Timeout In Seconds - The number of seconds to allow the virus scanner to run before timing out. Used when virusScannerType is Generic. Defaults to '120'. Licensed editions v2.1.0+ only. See <Xref title="Virus Check" value="virus-check" />.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coming from an accessibility side, having so many links that all have the same text isn't great. Since these are all the same link essentially, what if we put one sentence above the list that points to it. Something like Learn more about <Xref title="Virus Checking configuration" value="virus-check" /> on our detailed docs.. We could then remove these repetitive links. on each list item.

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