Replace Salesforce KB links with local KB links in Privilege Secure docs

[jake-mahon-netwrix]

Summary

Replaces broken Salesforce KB links with local KB article references in Privilege Secure documentation.

Changes

• Files changed: 5 files
• Links fixed: 5 Salesforce links
• New format: /docs/kb/privilegesecure/article-name

Example Fixes

Before:

[Exclusions for Antivirus (AV) & Endpoint Software](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000Hi8CAE.html)

After:

[Exclusions for Antivirus (AV) & Endpoint Software](/docs/kb/privilegesecure/exclusions_for_antivirus_(av)_&_endpoint_software)

Files Changed

• docs/privilegesecure/4.2/install/components/components.md
• docs/privilegesecure/4.2/install/servicesonadditional/actionservice.md
• Multiple other installation documentation files

Testing

✅ All KB articles exist in /docs/kb/privilegesecure/
✅ Links use correct Docusaurus format (no .md extension)

---

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]

[claude]

Pull Request Review: Replace Salesforce KB links with local KB links

Overview

This PR successfully replaces 5 broken Salesforce KB links with local documentation references across Privilege Secure installation documentation for versions 4.1 and 4.2.

---

✅ Positive Findings

Code Quality

• Clean, focused changes: The PR has a clear, single purpose with minimal surface area (5 additions, 5 deletions across 5 files)
• Consistent implementation: All link replacements follow the same pattern and format
• Proper link structure: New links correctly use Docusaurus format without .md extensions
• Verified targets: All target KB articles exist at the specified paths:
  • docs/kb/privilegesecure/exclusions-for-antivirus-av-endpoint-software.md
  • docs/kb/privilegesecure/invoking-desktop-ssh-client-automatically.md

Best Practices

• Documentation hygiene: Replacing external Salesforce links with internal documentation improves maintainability
• User experience: Local links provide better navigation and avoid external dependencies
• Version consistency: Changes applied consistently across both 4.1 and 4.2 documentation versions

---

⚠️ Issues Found

IMPORTANT: Link Format Inconsistency

The target KB articles themselves contain links with .md extensions, which is inconsistent with this PR's approach (correctly omitting .md).

Affected files:

• docs/kb/privilegesecure/invoking-desktop-ssh-client-automatically.md:57
• docs/kb/privilegesecure/registering-and-using-the-sbpam-url-ssh-protocol-handler.md:31
• docs/kb/privilegesecure/registering-and-using-the-sbpam-url-ssh-protocol-handler.md:167

Example:

# Current (incorrect)
[Registering and Using the sbpam-url SSH Protocol Handler](/docs/kb/privilegesecure/registering-and-using-the-sbpam-url-ssh-protocol-handler.md)

# Should be (consistent with this PR)
[Registering and Using the sbpam-url SSH Protocol Handler](/docs/kb/privilegesecure/registering-and-using-the-sbpam-url-ssh-protocol-handler)

Recommendation: Either:

1. Remove .md extensions from the KB articles in a follow-up PR, OR
2. Add those fixes to this PR to ensure consistency across all documentation

---

🔍 Additional Observations

Potential Scope Extension

A search revealed 2 remaining Salesforce KB links in the Privilege Secure documentation:

• docs/privilegesecure/4.2/install/components/components.md
• docs/privilegesecure/4.1/install/components/components.md

These appear to be different articles than the ones addressed in this PR. Consider checking if these also need updating.

Security

✅ No security concerns - this is a documentation-only change

Performance

✅ No performance impact - link updates only

Testing

✅ PR description confirms testing was performed:

• All KB articles verified to exist
• Link format verified as correct

---

📋 Recommendations

Required Before Merge:

1. Fix .md extension inconsistency in the target KB articles (either in this PR or create a follow-up issue)

Optional Improvements:

2. Investigate remaining Salesforce links in the components.md files
3. Consider a comprehensive audit to find all remaining Salesforce KB links across the entire docs repository

---

Summary

Overall Assessment: ✅ Approve with minor concerns

This is a well-executed PR that improves documentation quality. The changes are correct, consistent, and follow Docusaurus best practices. The only issue is the pre-existing inconsistency in the target KB articles themselves, which should be addressed to maintain documentation standards.

Great work on improving the documentation! 🎉

---

Review generated with assistance from Claude Code

[claude]

Pull Request Review

Summary

This PR successfully replaces broken Salesforce knowledge base links with local KB article references in Privilege Secure documentation. The changes improve link maintainability and provide a better user experience by keeping users within the documentation site.

---

✅ Positive Aspects

1. Clear Purpose: The PR addresses a real maintenance issue by replacing external Salesforce links with internal documentation links.

2. Link Validation: All referenced KB articles exist in the repository:

   • exclusions-for-antivirus-av-endpoint-software.md ✓
   • invoking-desktop-ssh-client-automatically.md ✓

3. Consistent Format: The new links follow proper Docusaurus format without .md extensions, which is correct.

4. Documentation Cleanup: The PR also includes minor formatting improvements (removing extra blank lines).

5. Scope: Changes are well-contained to 5 files across both 4.1 and 4.2 versions of Privilege Secure docs.

---

⚠️ Issues Found

1. Incomplete Link Replacement (High Priority)

There is one Salesforce link that was not replaced in the PR:

File: docs/privilegesecure/4.2/install/components/components.md:59

Current (after PR):

[How to Configure High Availability (HA) Using SbPAM.HaMgr.exe (now NPS.HaMgr.exe)](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000HfOCAU.html)

Should be:

[How to Configure High Availability (HA) Using SbPAM.HaMgr.exe (now NPS.HaMgr.exe)](/docs/kb/privilegesecure/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations)

The corresponding KB article exists at docs/kb/privilegesecure/configuring-and-upgrading-in-high-availability-mode-and-using-remote-services-configurations.md.

This same link likely exists in version 4.1 as well. Please check:

• docs/privilegesecure/4.1/install/components/components.md

---

2. Minor Inconsistency in Formatting

In docs/privilegesecure/4.2/install/components/components.md:59, the diff shows the line was reformatted to be shorter, but this appears to be an unintentional change from the link replacement operation rather than a deliberate formatting improvement. Consider maintaining consistent line wrapping style.

---

📋 Recommendations

1. Complete the Link Replacement: Add the missing HA configuration link replacement to both 4.1 and 4.2 versions.

2. Verification: Run a comprehensive search to ensure no other Salesforce KB links remain:

   grep -r "helpcenter.netwrix.com/bundle/z-kb-articles-salesforce" docs/privilegesecure/
   grep -r "kb.netwrix.com" docs/privilegesecure/

3. Consider Other Products: If this pattern exists in other product documentation (endpointprotector, etc.), consider creating follow-up PRs for those as well.

---

🔍 Code Quality Assessment

• Best Practices: ✅ Follows Docusaurus link conventions
• Consistency: ⚠️ Missing one link replacement
• Testing: ✅ PR description confirms KB articles exist
• Documentation: ✅ Clear PR description with before/after examples

---

🎯 Verdict

Request Changes - The PR is almost ready but needs the missing Salesforce link replaced before merge. Once that's addressed, this will be a solid improvement to the documentation.

---

📝 Action Items

• Replace the HA configuration Salesforce link in components.md (both 4.1 and 4.2)
• Run grep search to confirm no other Salesforce KB links remain
• Update PR with the additional changes

---

Great work on improving the documentation infrastructure! 🚀

[claude]

Pull Request Review

Summary

This PR successfully replaces broken Salesforce KB links with local KB article references in Privilege Secure documentation. The changes improve link reliability and user experience by pointing to internal documentation rather than external Salesforce links.

✅ Strengths

1. Valid Link Targets: All referenced KB articles exist and are properly formatted:

   • /docs/kb/privilegesecure/exclusions-for-antivirus-av-endpoint-software ✓
   • /docs/kb/privilegesecure/invoking-desktop-ssh-client-automatically ✓

2. Correct Link Format: The new links follow Docusaurus conventions (no .md extension, absolute paths from /docs/)

3. Consistent Changes: Link replacements are applied uniformly across multiple versions (4.1 and 4.2)

4. Good Documentation: The PR description clearly explains the changes with before/after examples

⚠️ Issues Found

Critical: Incomplete Link Migration

Location: docs/privilegesecure/4.2/install/components/components.md:59

There's one remaining Salesforce link that was not migrated:

[How to Configure High Availability (HA) Using SbPAM.HaMgr.exe (now NPS.HaMgr.exe)](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000HfOCAU.html)

Recommendation: Check if a local KB article exists for this topic. If not, create one or track this as a follow-up item.

Major: Test Files in Production PR

Locations:

• docs/kb/general/test-a-draft-to-publish-version-2.md
• docs/kb/general/test-a-draft-to-publish-version-5.md
• docs/kb/general/test-a-draft-to-publish-version-6.md
• docs/kb/general/test-a-draft-to-publish-version-7.md

These 4 test files appear to be accidental inclusions:

• They contain placeholder/test content ("This is a test by [REDACTED]", "REDACTED_IMAGE")
• They use placeholder IDs (kA0Qk000000XXXXKAA)
• They reference sandbox environments
• They're marked as "draft" content
• The PR description only mentions 5 files changed, but 9 files are actually changed

Recommendation: These should be removed from this PR or moved to a separate PR if they're intentional.

📋 Code Quality

Positive Observations

• Markdown syntax is correct
• Link formatting is consistent
• No formatting degradation in modified sections

Minor: Inconsistent Line Wrapping

Location: docs/privilegesecure/4.2/install/components/components.md:59

The HA link is kept on one long line while other links in the PR are properly wrapped. For consistency, consider breaking this line.

Before:

consult the [How to Configure High Availability (HA) Using SbPAM.HaMgr.exe (now NPS.HaMgr.exe)](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u0000000HfOCAU.html) knowledge base article.

🔒 Security

No security concerns identified. The changes replace external links with internal references, which is actually a security improvement.

⚡ Performance

No performance impact. Link changes are purely navigational.

🧪 Test Coverage

The PR description mentions testing:

✅ All KB articles exist in /docs/kb/privilegesecure/
✅ Links use correct Docusaurus format (no .md extension)

I verified both target KB articles exist and are properly formatted. However, the test files suggest incomplete testing or branch management issues.

📝 Recommendations

Must Fix Before Merge

1. Remove test files from this PR (versions 2, 5, 6, 7 in /docs/kb/general/)
2. Address the remaining Salesforce link in components.md:59

Nice to Have

3. Run a repository-wide search for other Salesforce KB links that might need migration
4. Consider adding a linter rule to catch helpcenter.netwrix.com links in future PRs

Verdict

Request Changes - The core link replacement work is solid, but the accidental inclusion of 4 test files and 1 missed Salesforce link need to be addressed before merging.

---

🤖 Review generated with Claude Code