Skip to content

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
Copy link
Contributor

Pull Request Review: Threat Prevention .NET Dependencies KB

Summary

This PR successfully relocates and updates the .NET Dependencies KB article for Threat Prevention. The changes are well-structured and align with the documentation site's architecture. Overall, this is a solid PR with good practices.


✅ Positive Aspects

1. Excellent Organization & File Structure

  • Proper relocation from staging to the correct product directory structure
  • Follows the established KB folder convention with clear categorization
  • Image stored in the appropriate 0-images/ directory

2. Good Content Improvements

  • Replaced external Salesforce-hosted image with local copy (improves reliability and load times)
  • Fixed incorrect alt text from generic "Dialog box" to accurate "PowerShell Example Output"
  • Updated requirements link to point directly to the overview page (more specific and helpful)

3. Smart Strategic Decision

  • Removing cross-product links temporarily to avoid broken links is pragmatic
  • Clear documentation in the PR description about follow-up work

4. Proper Sidebar Integration

  • Correctly uncommented the Knowledge Base section in 8.0.js
  • The generateKBSidebar utility will automatically pick up the new file

📝 Minor Observations

1. Missing Newline at End of File

The markdown file is missing a trailing newline at the end:

- [Netwrix Threat Prevention Requirements](...)

Recommendation: Add a newline after the last line. This is a common best practice in version control and prevents potential git warnings.

2. Hardcoded Version in Link

The requirements link uses a hardcoded version 7_5:

https://docs.netwrix.com/docs/threatprevention/7_5/requirements/overview

Question: Should this link dynamically reflect the current version, or is 7.5 the canonical source for this information? If the KB is meant to be version-agnostic, consider whether this should point to the latest version or be documented as version-specific.

3. PowerShell Code Block

The PowerShell command is well-formatted with proper syntax highlighting. Good use of code fencing.


🔍 Technical Quality

Code Quality: ✅ Excellent

  • Clean diff with focused changes
  • No unnecessary modifications
  • Proper use of relative paths for images

Best Practices: ✅ Followed

  • Follows Docusaurus conventions for KB articles
  • Proper frontmatter with required fields (sidebar_label, title, description, keywords)
  • Metadata includes knowledge_article_id and products array for tracking

Security: ✅ No Concerns

  • No security issues identified
  • Replacing external Salesforce URL with local asset actually improves security posture
  • No inline scripts or potentially dangerous content

Performance: ✅ Improved

  • Local image hosting will reduce external dependencies
  • Faster page loads without external HTTP requests

Testing: ✅ Well Documented

PR description includes comprehensive testing checklist covering:

  • Dev server verification
  • Image display
  • Link navigation
  • Sidebar accessibility
  • Build success

🎯 Recommendations

Priority: Low

  1. Add trailing newline to the markdown file
  2. Consider version strategy for requirements link - document if 7.5 is intentional
  3. When restoring cross-product links (follow-up PR), ensure they use the same /docs/kb/ path structure for consistency

Documentation Suggestion

Consider adding a comment in the Related Articles section noting that cross-product links will be restored in a future update, so future maintainers understand the intentional omission.


📊 Review Summary

Category Status Notes
Code Quality ✅ Excellent Clean, focused changes
Best Practices ✅ Followed Proper conventions
Security ✅ No Issues Actually improved
Performance ✅ Improved Local assets
Test Coverage ✅ Adequate Well documented
Documentation ✅ Clear Good PR description

🚀 Conclusion

Recommendation: APPROVE with minor optional improvements.

This PR demonstrates good understanding of the documentation architecture and makes meaningful improvements to the KB article. The strategic approach to cross-product links shows thoughtful planning. The changes are safe to merge as-is, with the trailing newline being the only suggestion worth considering (and even that is very minor).

Great work! 🎉

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