Skip to content

Update Threat Prevention .NET Dependencies KB: Relocate, update requirements link, replace Salesforce image, and enable 8.0 sidebar#50

Merged
hilram7 merged 7 commits intodevfrom
kb-threat-prevention-net-dependencies
Jan 20, 2026
Merged

Update Threat Prevention .NET Dependencies KB: Relocate, update requirements link, replace Salesforce image, and enable 8.0 sidebar#50
hilram7 merged 7 commits intodevfrom
kb-threat-prevention-net-dependencies

Conversation

@hilram7
Copy link
Collaborator

@hilram7 hilram7 commented Jan 15, 2026

Summary

Updates the .NET Dependencies KB for Netwrix Threat Prevention:

  • Relocates KB from staging to correct product directory
  • Updates requirements link to current Threat Prevention docs
  • Replaces Salesforce-hosted image with local copy
  • Removes cross-product KB links (will be restored in a follow-up PR after all 5 products merge)
  • Enables Knowledge Base section in Threat Prevention 8.0 sidebar

Changes

File Relocation

  • Moved net_dependencies_for_netwrix_threat_prevention.md from docs-staging/needs-relocation/ to docs/kb/threatprevention/configuration-and-administration/

Requirements Link

  • Updated link from generic placeholder to current docs: https://docs.netwrix.com/docs/threatprevention/7_5/requirements/overview

Image Replacement

  • Added local PowerShell example image to docs/kb/threatprevention/0-images/ka0Qk000000DG8bIAG.png
  • Replaced Salesforce URL with relative path ../0-images/ka0Qk000000DG8bIAG.png
  • Fixed incorrect alt text from "Dialog box for selecting monitoring plan settings" to "PowerShell Example Output"

Cross-Product Links

  • Removed cross-product KB links for broken link prevention
  • Links will be restored in a follow-up PR after all 5 product KBs merge

Sidebar Fix

  • Uncommented Knowledge Base section in sidebars/threatprevention/8.0.js
  • Enabled KB navigation for Threat Prevention v8.0

Technical Updates

Testing

  • ✅ Dev server: KB page loads correctly at /docs/kb/threatprevention/configuration-and-administration/net_dependencies_for_netwrix_threat_prevention
  • ✅ Image displays properly from local path
  • ✅ Requirements link navigates to correct Threat Prevention docs
  • ✅ KB accessible from sidebar navigation in v7.5 and v8.0
  • ✅ Build passes without errors

Related

  • Related PRs: Access Analyzer, Activity Monitor, Recovery AD, Threat Manager
  • Follow-up: Will restore cross-product KB links after all 5 merge

Hilary Ramirez added 5 commits January 13, 2026 14:05
- Moved KB from docs-staging/needs-relocation/ to configuration-and-administration/
- Updated requirements link to threatprevention/7_5/requirements/overview
- Fixed cross-product KB links to point to correct product directories
- Removed incorrect .md extensions from internal links
- Updated link text to 'Netwrix Threat Prevention Requirements'
- Changed URL to point to requirements overview page
- Simplified wording to match new docs site structure
… copy and fix alt text

- Add local PowerShell example image to 0-images folder
- Replace incorrect Salesforce image with PowerShell output image
- Fix alt text from "Dialog box for selecting monitoring plan settings" to "PowerShell Example Output"
- Remove cross-product KB links per Option B strategy
@github-actions

This comment was marked as resolved.

@hilram7
Copy link
Collaborator Author

hilram7 commented Jan 16, 2026

@netwrix/threatprevention-docs team - This PR needs your review/approval. It relocates an NTP KB to its folder. I also added KBs to the NTP 8.0 sidebar.

@github-actions

This comment was marked as resolved.

@github-actions
Copy link
Contributor

Code Review: PR #50 - Update Threat Prevention .NET Dependencies KB

✅ Summary

This PR successfully relocates and updates the Threat Prevention .NET Dependencies KB article. The changes are well-executed and align with the repository's documentation structure.

📋 Detailed Review

Code Quality & Best Practices ✅

Strengths:

  1. Proper file relocation: The KB article has been correctly moved from staging to the appropriate product directory following the established pattern
  2. Consistent structure: The file follows the same organizational pattern as other product KB articles (e.g., Activity Monitor, Recovery AD)
  3. Frontmatter compliance: The markdown frontmatter includes all required fields:
    • description, keywords, sidebar_label, tags, title
    • Product-specific metadata: knowledge_article_id, products
  4. Sidebar integration: The 8.0 sidebar correctly uses generateKBSidebar() utility, matching the pattern in v7.5
  5. Image organization: The image is correctly placed in the 0-images directory, following the KB image naming convention

Minor observations:

  1. The image path uses ../0-images/ka0Qk000000DG8bIAG.png (relative path), which is correct for Docusaurus
  2. The removed cross-product links are intentional per the PR description - this is a good defensive measure to prevent broken links

Potential Issues ⚠️

Content inconsistency (low priority):
Looking at similar KB files:

  • /docs/kb/activitymonitor/.../net_dependencies_for_netwrix_activity_monitor.md (line 30): Uses "ASP.NET Core" (with dot)
  • /docs/kb/threatprevention/.../net_dependencies_for_netwrix_threat_prevention.md (line 30): Uses "ASP .NET Core" (with space instead of dot)

Recommendation: For consistency, line 30 should read:

> **NOTE:** .NET Framework is not the same as ASP.NET Core, and having one does not mean you have the other. ASP.NET Core and .NET Desktop Runtime should show on the list of installed Apps & features; however, .NET Framework does not appear on that list. You can check which versions of .NET Framework you have installed by running the following command in PowerShell:

(Change "ASP .NET Core" to "ASP.NET Core" - notice the dot instead of space)

Performance Considerations ✅

  1. Build performance: The sidebar uses generateKBSidebar() which dynamically generates the KB navigation at build time - this is efficient and maintains consistency
  2. Image optimization: The PNG image (783x169, 8-bit RGBA) appears to be a reasonably sized screenshot. Consider converting to WebP format in the future for better performance per the README guidelines
  3. No runtime overhead: All changes are static content with no performance implications

Security Concerns ✅

  1. No security vulnerabilities detected
  2. Safe external link: The requirements link points to docs.netwrix.com (internal domain)
  3. Local image hosting: Replacing the Salesforce-hosted image with a local copy is a security improvement (eliminates external dependency)
  4. No sensitive data: The PowerShell command and example output are safe to display publicly

Test Coverage ✅

According to PR description, testing was performed:

  • ✅ Dev server: KB page loads correctly
  • ✅ Image displays properly from local path
  • ✅ Requirements link navigates correctly
  • ✅ KB accessible from sidebar navigation in v7.5 and v8.0
  • ✅ Build passes without errors

Recommended additional verification:

  1. Verify the image renders correctly in both light and dark modes (if applicable)
  2. Confirm that the relative image path ../0-images/ka0Qk000000DG8bIAG.png resolves correctly from the final URL path
  3. Test that the sidebar correctly categorizes this under "Configuration and Administration" in the KB

Documentation & Maintainability ✅

  1. Clear commit message intent: The PR description is comprehensive and explains all changes
  2. Follows repository patterns: The changes align with existing KB article structures
  3. Version consistency: Properly enables KB for v8.0 while maintaining v7.5 compatibility
  4. Follow-up plan: The PR description mentions restoring cross-product links in a future PR - good planning

🎯 Final Verdict

Approval Status: ✅ APPROVED with minor suggestion

This is a well-executed PR that follows best practices and repository conventions. The only suggestion is the minor typo fix for consistency ("ASP .NET Core" → "ASP.NET Core").

📝 Action Items

  1. Optional: Fix the "ASP .NET Core" typo on line 30 for consistency with other KB articles
  2. Future consideration: Convert PNG images to WebP format per repository guidelines for better performance

Great work on this migration! The systematic approach to relocating KB articles across products is well-planned and executed.

@hilram7 hilram7 merged commit 5eef5f4 into dev Jan 20, 2026
7 checks passed
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.

3 participants