Skip to content

Conversation

@hilram7
Copy link
Collaborator

@hilram7 hilram7 commented Jan 15, 2026

Summary

Updates the .NET Dependencies KB for Netwrix Access Analyzer:

  • Relocates KB from staging to correct product directory
  • Updates requirements link to current Access Analyzer 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)

Changes

File Relocation

  • Moved net_dependencies_for_netwrix_access_analyzer.md from docs-staging/needs-relocation/ to docs/kb/accessanalyzer/reference-and-technical-specifications/

Requirements Link

  • Updated link from generic placeholder to current docs: https://docs.netwrix.com/docs/accessanalyzer/12_0/requirements/overview

Image Replacement

  • Added local PowerShell example image to docs/kb/accessanalyzer/0-images/ka0Qk000000DG8bIAG.png
  • Replaced Salesforce URL with relative path ../0-images/ka0Qk000000DG8bIAG.png

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

Testing

  • ✅ Dev server: KB page loads correctly at /docs/kb/accessanalyzer/reference-and-technical-specifications/net_dependencies_for_netwrix_access_analyzer
  • ✅ Image displays properly from local path
  • ✅ Requirements link navigates to correct Access Analyzer docs
  • ✅ KB accessible from sidebar navigation
  • ✅ Build passes without errors

Related

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

Hilary Ramirez added 3 commits January 15, 2026 10:01
- Moved KB from docs-staging/needs-relocation/ to reference-and-technical-specifications/
- Updated question text to remove Activity Monitor reference
- Added correct requirements link (accessanalyzer/12_0/requirements/overview)
- Restored cross-product .NET dependency KB links with correct paths
- Hyperlinked 'Netwrix Access Analyzer Requirements' to requirements page
- Simplified sentence to match new docs site structure
- Removed cross-product .NET KB links (will be restored in Phase 1 final PR)
- Added PowerShell example image locally (ka0Qk000000DG8bIAG.png)
- Updated image reference from Salesforce URL to relative path
- Keeps only Access Analyzer requirements link for clean CI build
@github-actions

This comment was marked as resolved.

@hilram7 hilram7 marked this pull request as ready for review January 16, 2026 22:03
@hilram7 hilram7 requested a review from a team as a code owner January 16, 2026 22:03
Copy link
Contributor

@tay-caliguiri tay-caliguiri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove any mention of StealthAUDIT v11.5 here because it is no longer supported?

@github-actions

This comment was marked as resolved.

Removed references to StealthAUDIT 11.5 dependencies from the documentation as it's no longer supported.
@github-actions

This comment was marked as resolved.

@github-actions
Copy link
Contributor

Pull Request Review

I've reviewed PR #52 and here's my feedback:

✅ Strengths

  1. Well-structured PR description - The summary clearly explains all changes including file relocation, link updates, image replacement, and temporary removal of cross-product links.

  2. Proper file relocation - Moving the KB article from docs-staging/needs-relocation/ to the correct product directory follows the repository structure.

  3. Image optimization - Replacing the external Salesforce-hosted image with a local copy improves:

    • Page load performance
    • Reliability (no external dependencies)
    • Content ownership and control
  4. Good documentation hygiene - Removing broken cross-product links temporarily to prevent broken links shows attention to quality.

  5. Testing completed - The PR description shows thorough testing of all functionality.

📝 Code Quality Observations

Frontmatter consistency:
The frontmatter follows the standard structure seen in other KB articles, with one minor inconsistency:

  • Other reference articles use access-analyzer in the products field (with hyphen)
  • This article uses accessanalyzer (without hyphen)

Example from other files:

products:
  - access-analyzer

This file:

products:
  - accessanalyzer

Consider checking which is the canonical format and using it consistently.

📋 Content Changes Review

Removed content (comparing old vs new):

  1. Question section - Simplified from "Which version of .NET is required for Netwrix Access Analyzer and Netwrix Activity Monitor?" to just "Which version of .NET is required for Netwrix Access Analyzer?"

    • ✅ Good change - focuses on Access Analyzer only since Activity Monitor has its own KB article
  2. StealthAUDIT legacy product references removed:

    • StealthAUDIT 11.5
    • StealthAUDIT Access Information Center version 11.5
    • StealthAUDIT Sensitive Data Discovery Add-on version 11.5
    • StealthAUDIT File System Scanning Proxy (FSAA Proxy) 11.5
    • ✅ Good change - removes legacy product names for cleaner, more focused content
  3. Related Articles section - Simplified significantly:

    • Old version had TODO comments and commented-out links
    • New version has clean, working links only
    • ✅ Good change - removes clutter and broken links
  4. Requirements link added:

    • Changed from TODO comment to actual working link: https://docs.netwrix.com/docs/accessanalyzer/12_0/requirements/overview
    • ✅ Good change - provides users with actionable reference

🔒 Security Considerations

✅ No security concerns identified:

  • No sensitive data in markdown files
  • No executable code changes
  • Image file is binary (PNG) - standard format
  • Links point to official Netwrix documentation domains

⚡ Performance Considerations

✅ Performance improvements:

  • Local image hosting eliminates external HTTP request to Salesforce
  • PNG format is acceptable for screenshots (though WebP would be more optimal per README guidelines)

Minor suggestion: Consider converting the PNG to WebP format in a follow-up, as the README states: "Format: Use .webp for performance"

🧪 Test Coverage

✅ Adequate testing documented:

  • Dev server functionality verified
  • Image display confirmed
  • Links validated
  • Sidebar navigation tested
  • Build passes

No automated tests needed for documentation changes.

🎯 Best Practices

Followed:

  • ✅ Proper KB article structure with frontmatter
  • ✅ Clear section headings (Related Query, Question, Answer, Related Articles)
  • ✅ Code block formatting for PowerShell command
  • ✅ Descriptive image alt text
  • ✅ Relative path for local image
  • ✅ Maintains knowledge_article_id for tracking

Suggestions:

  1. Verify the products field format (hyphenated vs non-hyphenated)
  2. Consider WebP format for images in future updates
  3. Ensure the image path ../0-images/ follows the repository's standard image location convention

📊 Summary

Overall Assessment:Approved with minor suggestions

This is a solid documentation update that improves content quality, removes broken links, and enhances performance. The changes are well-documented, properly tested, and follow the repository's structure. The minor inconsistencies noted above are optional improvements and don't block merging.

Risk Level: Low - Documentation-only changes with no code impact

Recommendation: Ready to merge after addressing the products field format if needed.


Review performed by Claude Code AI Assistant

Copy link
Collaborator Author

@hilram7 hilram7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made requested update - removed v11.5 references

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