Replace Salesforce KB links with local KB links in Activity Monitor docs

[jake-mahon-netwrix]

Summary

Replaces broken Salesforce KB links with local KB article references in Activity Monitor documentation.

Changes

• Files changed: 2 files (docs/activitymonitor/8.0/install/upgrade/upgrade.md)
• Links fixed: 1 Salesforce link
• New format: /docs/kb/activitymonitor/article-name

Example Fix

Before:

[Netwrix Activity Monitor Paths](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA04u00000111AOCAY.html)

After:

[Netwrix Activity Monitor Paths](/docs/kb/activitymonitor/netwrix_activity_monitor_(nam)_7.0_paths)

Testing

✅ KB article exists in /docs/kb/activitymonitor/
✅ Link uses correct Docusaurus format (no .md extension)

---

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]

[claude]

Pull Request Review

Summary

This PR replaces broken Salesforce KB links with local KB article references in Activity Monitor upgrade documentation for versions 7.1 and 8.0. The changes are focused, well-documented, and improve the user experience by pointing to accessible internal documentation.

---

✅ Strengths

1. Clear Purpose: The PR addresses a real problem - broken external Salesforce links that should point to internal KB articles.

2. Verified Target: The target KB article exists at docs/kb/activitymonitor/netwrix_activity_monitor_(nam)_7.0_paths.md and contains the expected content about NAM 7.0 paths.

3. Correct Link Format: The new links follow the proper Docusaurus format (/docs/kb/... without .md extension).

4. Consistent Pattern: Both files are updated with the same approach, maintaining consistency across versions.

5. Minimal Change: Only 2 files modified with 2 additions and 2 deletions - a focused, surgical change.

---

⚠️ Issues Found

Critical Issue: Version Mismatch

Location: Both docs/activitymonitor/7.1/install/upgrade/upgrade.md:22 and docs/activitymonitor/8.0/install/upgrade/upgrade.md:21

Problem: The linked KB article is titled "NAM 7.0 Paths" but is being referenced in documentation for:

• Version 7.1 (which mentions "paths have been updated from Activity Monitor 7.0")
• Version 8.0 (which mentions "paths have been updated from Activity Monitor 7.1")

Context:

• The 7.1 docs say: "The installation and configuration paths for Netwrix Activity Monitor 7.1 have been updated from Activity Monitor 7.0."
• The 8.0 docs say: "The installation and configuration paths for Netwrix Activity Monitor 8.0 have been updated from Activity Monitor 7.1."

Questions:

1. Should the 7.1 upgrade docs reference a "NAM 7.1 Paths" article instead?
2. Should the 8.0 upgrade docs reference a "NAM 8.0 Paths" article instead?
3. Or are the paths actually the same across all versions 7.0/7.1/8.0?

Recommendation: Please verify whether:

• Additional KB articles exist for NAM 7.1 and 8.0 paths
• The NAM 7.0 paths article is intentionally used for all 7.x and 8.x versions
• The link text should be updated to clarify this (e.g., "NAM 7.x Paths" or "NAM Paths Reference")

---

📋 Other Observations

Minor: Link Text Inconsistency

• 7.1 file: Link text is "Netwrix Activity Monitor 7.1 Paths"
• 8.0 file: Link text is "Netwrix Activity Monitor Paths" (no version number)
• Target article: Title is "Netwrix Activity Monitor (NAM) 7.0 Paths"

While not a blocker, it would be cleaner if the link text matched the actual article title or was consistently versioned.

Context: Broader Link Migration

The grep search shows 149+ Salesforce KB links still exist across the repository. This PR is part of a larger migration effort, which is good to see progressing incrementally.

---

🔍 Technical Review

Code Quality: ✅ Excellent

• Clean markdown changes
• No syntax errors
• Proper formatting maintained

Potential Bugs: ⚠️ See version mismatch issue above

• Links will work but may point to incorrect version information
• Users might be confused if paths differ between versions

Performance: ✅ N/A

• Documentation changes have no performance impact
• Local links are faster than external Salesforce links

Security: ✅ Good

• Removes external dependency on Salesforce
• Reduces risk of broken links
• No security concerns with internal documentation links

Test Coverage: ⚠️ Verification Needed

• ✅ Confirmed: Target KB article exists
• ⚠️ Need to verify: Article content matches the versions being documented
• Suggestion: Consider adding a build-time link checker if not already present

---

🎯 Recommendations

1. Before Merging: Clarify the version mismatch issue - ensure the 7.0 Paths article is the correct reference for both 7.1 and 8.0 upgrade docs.

2. Consider: Standardizing link text to match the target article title for consistency.

3. Future Enhancement: Continue the good work of migrating Salesforce links - there are 149+ more to go!

---

Verdict

Conditional Approval ✅ with clarification needed on the version mismatch issue. The technical implementation is sound, but we need to ensure we're pointing users to the correct version-specific information.

---

🤖 Review generated by Claude Code

[paul-sh]

Although those new links do not open for me, I suspect they will after integration

[claude]

Pull Request Review

Summary

This PR successfully replaces broken external Salesforce KB links with local KB article references in Activity Monitor documentation. The changes are well-scoped and improve documentation maintainability.

✅ Strengths

1. Code Quality & Best Practices

• Correct link format: Uses proper Docusaurus internal linking format (/docs/kb/...) without .md extensions
• Consistent approach: Both files updated follow the same pattern
• Verified target: The KB article /docs/kb/activitymonitor/netwrix_activity_monitor_(nam)_7.0_paths.md exists and contains relevant content
• Minimal scope: Only changes what's necessary - 2 files, 2 lines modified

2. Documentation Quality

• Content accuracy: The linked KB article (kA04u00000111AOCAY) matches the original Salesforce article reference
• Context preserved: Link text appropriately describes the destination
• Proper metadata: KB article has proper frontmatter including the original knowledge_article_id

3. Maintainability Benefits

• Eliminates dependency on external Salesforce links that can break
• Centralizes knowledge base content within the repository
• Enables version control and easier updates

🔍 Observations & Considerations

1. Version Accuracy Consideration

The KB article is titled "NAM 7.0 Paths" but is being referenced from both:

• docs/activitymonitor/7.1/install/upgrade/upgrade.md (mentions "7.1 paths")
• docs/activitymonitor/8.0/install/upgrade/upgrade.md (mentions "8.0 paths")

Question: Does the 7.0 paths article apply to versions 7.1 and 8.0, or should there be version-specific KB articles? The content describes path changes "from 6.0" to 7.0, so this might need clarification if paths changed again in 7.1 or 8.0.

Recommendation: Consider either:

• Updating the KB article title to reflect it applies to 7.0+ versions
• Creating version-specific KB articles if paths differ between versions
• Adding a note in the upgrade docs clarifying the paths are consistent across versions

2. Complete Migration Coverage

Good job! Grep search confirms no other Salesforce KB links remain in the Activity Monitor documentation.

3. Link Text Consistency

Minor observation: The link text differs between the two files:

• 7.1 version: "Netwrix Activity Monitor 7.1 Paths"
• 8.0 version: "Netwrix Activity Monitor Paths" (no version number)

Both link to the same 7.0 paths article. Consider standardizing the link text if they reference the same resource.

🧪 Testing Notes

The PR description indicates:

• ✅ KB article existence verified
• ✅ Docusaurus link format confirmed

Additional testing recommendations:

• Verify links render correctly in local build (npm run start)
• Check that version selector works properly if multiple versions are displayed
• Confirm no broken link warnings in build output

🔒 Security & Performance

• ✅ No security concerns (documentation-only change)
• ✅ Performance improved (local links are faster than external)
• ✅ No external dependencies introduced

📋 Test Coverage

N/A - Documentation changes don't require automated tests, but manual verification of link functionality is recommended.

🎯 Final Recommendation

APPROVE with minor suggestions for consideration.

This is a solid improvement that:

• Fixes broken external links
• Improves documentation maintainability
• Uses correct internal linking syntax
• Has minimal scope and clear impact

The version-specific question raised above is worth discussing but shouldn't block this PR unless there are known differences in paths between versions 7.0, 7.1, and 8.0.

---

Review conducted via automated analysis of PR #348

[claude]

Pull Request Review

Summary

This PR replaces broken Salesforce KB links with local KB article references in Activity Monitor documentation (versions 7.1 and 8.0). The changes are straightforward and improve documentation maintainability.

---

✅ Strengths

1. Valid Link Target: The KB article /docs/kb/activitymonitor/netwrix_activity_monitor_(nam)_7.0_paths.md exists and contains the expected content about NAM paths.

2. Correct Docusaurus Format: The links properly use the Docusaurus format without .md extensions, which is the correct approach for internal documentation links.

3. Consistent Text Improvement: Adding "knowledge base article" to the link text improves clarity and helps users understand they're being directed to KB content.

4. Small, Focused Change: The PR has a clear, single purpose and doesn't introduce unnecessary changes.

---

⚠️ Issues & Recommendations

1. Version Mismatch - Critical Issue

The KB article being linked is specifically for NAM 7.0 paths (netwrix_activity_monitor_(nam)_7.0_paths), but it's being referenced in documentation for versions 7.1 and 8.0:

• File: docs/activitymonitor/7.1/install/upgrade/upgrade.md:22

  • Text says: "Netwrix Activity Monitor 7.1 Paths"
  • Links to: NAM 7.0 paths article

• File: docs/activitymonitor/8.0/install/upgrade/upgrade.md:21

  • Text says: "Netwrix Activity Monitor Paths"
  • Links to: NAM 7.0 paths article

Recommendation:

• If version 7.0, 7.1, and 8.0 all share the same paths, update the KB article title to reflect this (e.g., "NAM 7.x Paths" or list applicable versions).
• If paths differ between versions, create separate KB articles for each version and link appropriately.
• Update the link text to match the actual KB article being referenced.

2. Link Text Inconsistency

The two files have slightly different link text:

• Version 7.1: "Netwrix Activity Monitor 7.1 Paths"
• Version 8.0: "Netwrix Activity Monitor Paths" (no version specified)

Both link to the same 7.0 article.

Recommendation: Use consistent, accurate link text that matches the target article's title or clearly indicates which versions it applies to.

---

📋 Additional Observations

Code Quality

• ✅ Changes follow Docusaurus markdown conventions
• ✅ Proper use of relative paths
• ✅ No syntax errors

Performance

• ✅ Internal links are more performant than external Salesforce links
• ✅ No dead links introduced (target file exists)

Security

• ✅ No security concerns
• ✅ Removes dependency on external Salesforce domain

Testing

• ✅ PR author verified KB article exists
• ⚠️ Should verify content accuracy for each version

---

🔍 Suggested Action Items

1. High Priority: Clarify if NAM 7.0 paths article is accurate for versions 7.1 and 8.0
2. Medium Priority: Standardize link text to match the actual KB article title
3. Optional: Consider if version-specific KB articles would be more appropriate

---

📝 Test Coverage

No automated tests appear to be needed for documentation link changes. Manual verification should include:

• Links resolve correctly in local build
• KB article content is accurate for all referencing versions
• No broken links in production build

---

Overall Assessment

The technical implementation is correct, but there's a content accuracy concern regarding version-specific information. Please verify that the NAM 7.0 paths article is applicable to versions 7.1 and 8.0, or create version-specific KB articles as needed.

Recommendation: Request verification from product team before merging.