Add Change Tracker KB folders, sidebar, and migrate initial articles

[hilram7]

Summary

Initializes the Change Tracker knowledge base folder and migrates 4 existing KB articles from the general KB section. This is the first phase of an ongoing project to consolidate all Change Tracker documentation into a dedicated KB section.

Changes Made

• Added _category_.json configuration for Change Tracker KB folder
• Moved 4 articles from general KB to Change Tracker KB:
  • Audit and Logging (1 article)
    • corrupt-errorevent-in-event-reports
  • Database and Diagnostics (1 article)
    • disk_space_occupied_by_core._files_in_gen_7_agent_servers
  • Troubleshooting and Errors (2 articles)
    • rolling-log_fix_error_nnt.hub.serviceclient.hubadapter_-_certificate_thumbprint_does_not_match_trust
    • rolling-log_fix_hub_connection_failed._403_server_message_ip_address_blocked_loginfailures

Files Changed

• 5 files total:
  • 4 KB articles moved from general KB to Change Tracker KB
  • 1 category configuration file added

Project Status

• 🚧 Work in Progress — This PR represents the initial phase of Change Tracker KB consolidation.
  The majority of Change Tracker articles are not yet imported and will be added in subsequent phases.

Testing

• 🔁 Branch rebased onto latest dev
• ✅ Server build completed successfully
• ⏳ Navigation and link verification still needed (to be completed after repository rebuild)
• ➕ Additional Change Tracker articles to be imported in future PRs

---

Restored from archived repository with clean commit history.
Archived PR: https://github.com/netwrix/docs-archive-2025-12-22/pull/447

[github-actions]

Pull Request Review: Change Tracker KB Migration

Overall Assessment

✅ Approved with minor suggestions - This is a well-structured PR that successfully migrates 4 Change Tracker KB articles with proper organization and integration. The implementation follows repository conventions and provides a solid foundation for future KB consolidation.

---

🎯 Strengths

Structure & Organization

• ✅ Proper folder hierarchy with categorized subdirectories
• ✅ Consistent with existing KB patterns (compared to Access Analyzer KB)
• ✅ Index page follows established conventions
• ✅ Category configuration properly set up

Sidebar Integration

• ✅ Correctly uses generateKBSidebar() utility function
• ✅ Properly added to both version sidebars (8.0.js and 8.1.js)
• ✅ Follows existing sidebar patterns from other products

Documentation Quality

• ✅ All articles have complete frontmatter with required fields
• ✅ Knowledge article IDs properly preserved
• ✅ Product tags correctly set to change-tracker
• ✅ Category tags align with folder structure

---

📝 Code Quality Review

Frontmatter Consistency

All KB articles include:

• ✅ title, description, sidebar_label
• ✅ keywords, products, tags
• ✅ knowledge_article_id for tracking

Markdown Quality

• ✅ Proper heading hierarchy (H1 → H2 → H3)
• ✅ Code blocks with appropriate syntax highlighting
• ✅ Consistent formatting across articles

---

⚠️ Issues & Recommendations

1. Missing Newline at End of File (Minor)

Location: docs/kb/changetracker/database-and-diagnostics/disk_space_occupied_by_core._files_in_gen_7_agent_servers.md:29

Issue:

2. These core files can be safely deleted to free up disk space.
\ No newline at end of file

Fix: Add a newline at the end of the file (standard practice for text files)

Impact: Low - Won't affect rendering but violates common text file conventions

---

2. XML Formatting Inconsistency (Minor)

Location: rolling-log_fix_error_nnt.hub.serviceclient.hubadapter... and rolling-log_fix_hub_connection_failed...

Current:

<Password><YourAgentPassword></Password>

Suggested:

<Password>YourAgentPassword</Password>

Rationale: The nested <YourAgentPassword> makes it appear as an XML tag rather than placeholder text. Consider using one of:

• <Password>your_password_here</Password>
• <Password>[Your Agent Password]</Password>
• Keep as-is but clarify in surrounding text

Impact: Low - May slightly confuse users about XML syntax

---

3. Potential Path Validation Issue (Low Priority)

Location: Multiple articles reference file paths

Observation: Some articles reference paths like:

• C:\ProgramData\NNT\gen7agent.service\ (Windows)
• /opt/nnt/gen7agent/bin/ (Linux)

Suggestion: Consider adding a note about platform-specific paths or validating that these paths are current for the versions being documented (8.0 and 8.1).

Impact: Medium - If paths have changed between versions, users may be confused

---

🔒 Security Review

Password Handling

Status: ✅ Acceptable

The articles correctly:

• Instruct users to replace encrypted <E1></E1> tags with plaintext <Password></Password> tags temporarily
• Note that passwords are automatically re-encrypted by the service
• Include the 10-minute cooldown security feature explanation

No security concerns identified.

Certificate Thumbprints

Status: ✅ Good

• Example thumbprints are clearly placeholders
• Instructions are clear about finding the correct thumbprint from error messages
• No real credentials exposed

---

🧪 Test Coverage

Not Applicable - This PR contains documentation only, no executable code.

Suggested Testing:

• ✅ Build passes (mentioned in PR description)
• ⏳ Navigation verification (marked as pending in PR description)
• ✅ Link verification after repository rebuild

---

🚀 Performance Considerations

Sidebar Generation

Status: ✅ Optimal

The generateKBSidebar() function is used correctly:

• Runs at build time (not runtime)
• Efficiently processes folder structure
• No performance concerns

File Sizes

All KB articles are appropriately sized (29-67 lines), ensuring:

• Fast page loads
• Good user experience
• Efficient search indexing

---

📋 Checklist Verification

Item	Status
Proper frontmatter	✅
Consistent formatting	✅
Valid markdown	✅
Category configuration	✅
Sidebar integration	✅
Knowledge article IDs	✅
No hardcoded credentials	✅
Index page present	✅

---

💡 Suggestions for Future PRs

1. Consider adding a migration tracking document to track which articles have been migrated from the general KB
2. Version-specific documentation - If paths or procedures differ between 8.0 and 8.1, consider adding version callouts
3. Cross-references - Add links between related KB articles where appropriate
4. Screenshots - Consider adding visual aids for complex UI procedures (if available)

---

🎬 Conclusion

This PR successfully lays the groundwork for the Change Tracker KB consolidation project. The implementation is clean, follows established patterns, and integrates seamlessly with the existing documentation structure.

Recommendation: ✅ Approve and merge after addressing the minor newline issue in disk_space_occupied_by_core._files_in_gen_7_agent_servers.md.

Next Steps After Merge:

1. Verify navigation works correctly after repository rebuild
2. Test search functionality for the new articles
3. Continue migrating remaining Change Tracker KB articles

---

Great work on this migration! The attention to detail and consistent formatting will make the Change Tracker KB section easy to maintain and expand. 👏

[hilram7]

Testing Verification:

• ✅ Serve test passed - all pages accessible
• ✅ Two articles loaded correctly with generic password placeholders (not default passwords)
• ✅ Sidebar "Knowledge Base" section appears in Change Tracker docs
• ✅ Sidebar labels now distinguish between "403 IP Address Blocked" and "Certificate Thumbprint Mismatch"
• ✅ Build completed successfully without errors

[github-actions]

PR Review Summary

Thank you for this well-organized PR that initializes the Change Tracker Knowledge Base section. The migration is clean and the articles are well-structured. Below is my detailed review:

---

✅ Strengths

1. Excellent PR Organization

• Clear commit history with descriptive messages
• Well-documented PR description with summary and project status
• Proper phased approach for a large migration project
• Good use of category organization (Audit and Logging, Database and Diagnostics, Troubleshooting and Errors)

2. Code Quality

• Sidebar integration: Proper use of generateKBSidebar utility in both 8.0.js and 8.1.js
• Category configuration: Clean and consistent with existing patterns
• No code duplication: Reuses existing utility functions appropriately

3. Documentation Quality

• Consistent frontmatter: All articles include proper metadata (description, keywords, sidebar_label, tags, products, knowledge_article_id)
• Clear structure: Articles follow a consistent Symptoms → Cause → Resolution format
• Platform-specific instructions: Good separation of Windows and Linux procedures
• Code examples: XML configuration examples are helpful and properly formatted
• External links: Updated to point to current docs.netwrix.com instead of deprecated kb.netwrix.com

4. Content Accuracy

• File paths are correct:
  • Windows: C:\ProgramData\NNT\gen7agent.app.netcore\
  • Linux: /var/nnt/gen7agent.app.netcore/
  • Linux binaries: /opt/nnt/gen7agentcore/bin/
• XML formatting: Properly uses Password tags with YourAgentPassword placeholder in examples
• Cross-references: Good use of internal links to other documentation sections

---

🔍 Observations & Minor Suggestions

1. File Naming Convention

Some filenames use underscores and periods inconsistently:

• disk_space_occupied_by_core.files_in_gen_7_agent_servers.md (has core. )
• rolling-log_fix_error... (uses underscores)

Suggestion: Consider using consistent kebab-case for better URL readability, though this is not critical since sidebar labels override the display names.

2. Security Considerations

The articles appropriately:

• ✅ Instruct users to use their actual passwords (not hardcoded values)
• ✅ Explain that passwords will be auto-encrypted by the agent
• ✅ Reference the correct thumbprint from error messages
• ✅ Warn about critical errors that prevent monitoring

Good practice: The articles avoid including real credentials or sensitive data in examples.

3. Missing Newline

The certificate thumbprint article is missing a trailing newline at the end of the file. While not critical, it is a best practice to include one.

4. Content Completeness

The disk space article is quite brief. Consider adding:

• Recommended cleanup commands (e.g., rm /opt/nnt/gen7agentcore/bin/core.*)
• Notes about when/why core dumps are generated
• Guidance on whether to investigate before deletion

However, this is optional and the current content is functional.

---

🧪 Test Coverage

What is Covered:

• ✅ Build success confirmed in PR description
• ✅ Sidebar configuration properly integrated

Recommended Additional Testing:

1. Navigate to the KB landing page (/docs/kb/changetracker/) to verify the index displays correctly
2. Click through each article link to ensure routing works
3. Test the search function with keywords from the articles
4. Verify version switcher works with both 8.0 and 8.1 sidebars
5. Check mobile responsiveness for long article titles

---

🎯 Final Verdict

Status: ✅ Approved with minor suggestions

This is a high-quality PR that successfully:

• Establishes a solid foundation for the Change Tracker KB section
• Migrates 4 articles with proper categorization
• Integrates cleanly with the existing documentation infrastructure
• Maintains consistent formatting and metadata standards
• Addresses feedback from previous reviews (as noted in commit bb585c2)

The minor suggestions above are optional improvements and should not block merging. The PR is ready to merge once you have completed the navigation and link verification testing mentioned in your PR description.

---

📋 Checklist for Merge

• ✅ Code quality: Excellent
• ✅ Documentation quality: Very good
• ✅ Security: No concerns
• ✅ File structure: Follows conventions
• ⏳ Testing: Awaiting navigation/link verification (per PR description)

Recommendation: Merge after completing the pending navigation and link verification tests.

Great work on this migration! 🎉

[chills66]

This is the first time I've built the documentation on my machine so I don't know if these observations are to do with my build or are a more widespread issue

• When selecting 'Knowledge Base', nothing gets displayed in the main window. This is the same for all new menu items that appear under 'Knowledge Base'

• Selecting the leaf nodes which contain the new content, they display correctly within the main window but the lhs menu disappears and navigating back doesn't go to any of the 'Knowledge Base' pages