feat(dale): enable KB linting and add undefined-acronyms rule#745
Merged
feat(dale): enable KB linting and add undefined-acronyms rule#745
Conversation
Narrow scope to product-specific and non-standard acronyms per KB style guide guidance. Exclude well-known IT standards (SID, UID, DNS, SQL, etc.) and code literals in backticks.
…le-credential-selection Corrected future tense to present tense and reduced wordiness; verifies the undefined-acronyms dale rule produces clean output on a well-written KB article with no false positives.
… heading vs. body scope
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
1 participant
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.
Summary
undefined-acronymsdale rule that flags product-specific acronyms used without definition on first use (e.g. FSAA, AIC, SPAA, CAP, NPR) while excluding well-known IT standards.connection-profile-credential-selection.md.Rule behavior
The
undefined-acronymsrule follows the style guide pattern: "File System Access Audit (FSAA)" on first use, then "FSAA" thereafter.Does not flag:
Does flag:
Testing
KB articles (13):
docs/kb/accessanalyzer/connection-profiles-and-credentials/connection-profile-credential-selection.mdNo issues ✓
docs/kb/accessanalyzer/connection-profiles-and-credentials/determining_which_access_analyzer_collectors_ support_gmsa.mdpassive-voice: 3 · wordiness: 1 · undefined-acronyms: 2 (FSAA, SPAA)
docs/kb/accessanalyzer/installation-and-upgrades/access-analyzer-upgrade-workflow-aic.mdpassive-voice: 1 · wordiness: 1
docs/kb/accessanalyzer/troubleshooting-and-errors/error-removed-host-name-in-aic-andor-fsaa-host-table.mdpassive-voice: 3 · wordiness: 3
docs/kb/accessanalyzer/troubleshooting-and-errors/fsaa-registry-key-error.mdpassive-voice: 1 · undefined-acronyms: 1 (FSAA)
docs/kb/activitymonitor/integrations-and-data-sources/manually-setting-up-sharepoint-online-auditing.mdpassive-voice: 7 · wordiness: 3 · positional-references: 1 · undefined-acronyms: 4 (SPAA/SPSEEK, SPAC, NAM, UNC)
docs/kb/activitymonitor/monitoring-platforms-and-storage/recommended-performance-counters-for-sam.mdpassive-voice: 4 · wordiness: 1 · positional-references: 1 · undefined-acronyms: 3 (SAM, CEE, AMQP)
docs/kb/dataclassification/authentication-and-security/service-account-password-reset-for-netwrix-data-classification.mdmisplaced-modifiers: 1 · wordiness: 2 · positional-references: 2
docs/kb/dataclassification/features-and-operations/what-usage-and-license-data-is-sent-to-netwrix-by-netwrix-data-classification.mdpassive-voice: 3 · wordiness: 1
docs/kb/general/cloud-and-permissions/permission-scanning-errors-and-issues.mdpassive-voice: 4 · misplaced-modifiers: 1 · wordiness: 2 · positional-references: 1 · undefined-acronyms: 1 (FSAA)
docs/kb/general/troubleshooting-and-errors/spac-bulk-import-error.mdpassive-voice: 4 · wordiness: 1 · positional-references: 1 · undefined-acronyms: 3 (SPAC, SPAA, SPSEEK)
docs/kb/privilegesecure/authentication-and-mfa/add-active-directory-federation-services-ad-fs-as-an-authentication-connector-saml.md†passive-voice: 6 · wordiness: 2 · undefined-acronyms: 2 (SAML — now excluded, CORS)
docs/kb/privilegesecurediscovery/authentication-and-access/saml-assertion-not-yet-valid.mdwordiness: 1
Docs articles (10):
docs/accessanalyzer/12.0/requirements/filesystem/filesystems/netappcmode/activity/configurefpolicy.mdpassive-voice: 8 · minimizing-difficulty: 1 · positional-references: 2 · wordiness: 4 · undefined-acronyms: 1 (SVM)
docs/auditor/10.8/requirements/supporteddatasources/supporteddatasources.mdpassive-voice: 13 · wordiness: 3 · undefined-acronyms: 4 (CIFS, DSM, WAF, NS)
docs/changetracker/8.1/admin/devicediscoveryregistration/devicediscoveryregistration.mdpassive-voice: 8 · idioms: 2
docs/directorymanager/11.0/managementshell/scheduling/overview.mdNo issues ✓
docs/endpointprotector/gettingstarted.mdpassive-voice: 1 · wordiness: 1 · misplaced-modifiers: 1 · undefined-acronyms: 1 (CAP)
docs/passwordreset/3.3/administration/securing_password_reset.md†passive-voice: 2 · positional-references: 1 · wordiness: 1 · undefined-acronyms: 2 (NPR; DACL — now excluded)
docs/privilegesecure/4.2/admin/configuration/integrationconnector/integrationbyov/byovconnectorconfig.mdpassive-voice: 7 · wordiness: 2
docs/threatmanager/3.0/threats/overview.mdpassive-voice: 2 · wordiness: 2
docs/threatmanager/3.1/administration/configuration/integrations/activedirectorysync.mdpassive-voice: 4 · wordiness: 1 · undefined-acronyms: 1 (USN)
docs/threatmanager/3.1/administration/configuration/systemsettings/useraccess.mdpassive-voice: 7 · wordiness: 4 · undefined-acronyms: 1 (RADIUS)
No false positives on AD, LDAP, SSL, IIS, ACL, DACL, OU, or other well-known terms across any tested file.
Notes
vale-autofix.yml) does not yet run on KB articles — that requires additional workflow changes planned for a follow-up PR.