-
Notifications
You must be signed in to change notification settings - Fork 13
New KB on account exclusions #82
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Conversation
…is no domain trust relationship
This comment was marked as outdated.
This comment was marked as outdated.
Corrected warning admonition and related links header
This comment was marked as outdated.
This comment was marked as outdated.
Took some suggestions from Claude and made minor improvements
|
Pull Request Review: Account Exclusions KB Article SUMMARY: STRENGTHS:
DOCUMENTATION QUALITY ISSUES: PowerShell Code Block at lines 42-49:
Numbered List Formatting at lines 54-56:
Configuration File Path:
Frontmatter:
SECURITY CONSIDERATIONS: TECHNICAL ACCURACY: RECOMMENDATIONS SUMMARY: High Priority:
Medium Priority: Low Priority: APPROVAL STATUS: |
typo in powershell command
PR Review: New KB on Account ExclusionsThank you for this contribution! I've reviewed the new KB article on multi-domain account exclusions. Overall, this is a well-structured and helpful article that addresses a specific technical challenge. Below is my detailed feedback. ✅ Strengths
🔍 Issues FoundCritical: Missing Required Frontmatter FieldIssue: The article is missing the Location: docs/kb/activitymonitor/monitoring-platforms-and-storage/multi-domain-account-exclusions.md:1-14 Current frontmatter: ---
description: >-
products:
- activitymonitor
sidebar_label: Account Exclusions Cannot Add User from Untrusted Domain
tags: []
title: "Netwrix Activity Monitor Account Exclusions Cannot Add User from Untrusted Domain"
---Expected format (based on other articles in the same directory): ---
description: >-
This article explains...
keywords:
- Netwrix Activity Monitor
- Account
- Exclusions
- Multidomain
- No Trust
products:
- activitymonitor
sidebar_label: Account Exclusions Cannot Add User from Untrusted Domain
tags: []
title: "Netwrix Activity Monitor Account Exclusions Cannot Add User from Untrusted Domain"
knowledge_article_id: kA0Qk0000000000000
---Action Required: Add the High Priority: Admonition Format InconsistencyIssue: The article uses Docusaurus-style admonitions ( Location:
Current format: :::warning
**IMPORTANT**: If you mix commas and semicolons...
:::
:::note
The Activity Monitor filtering engine compares user SIDs directly...
:::Expected format (based on latency_with_netapp.md:45 and other articles): > **IMPORTANT:** If you mix commas and semicolons, the system may fail to load the exclusion or treat part of it as an invalid string.
> **NOTE:** The Activity Monitor filtering engine compares user SIDs directly. No name resolution is required once the SID is loaded, which is why this method works even without domain trust.Why this matters: Consistency across the documentation ensures proper rendering and maintains the established documentation style. Medium Priority: Section Naming ConventionIssue: The section is titled "Related Links" (plural) but only contains one link. Location: docs/kb/activitymonitor/monitoring-platforms-and-storage/multi-domain-account-exclusions.md:71 Current: ## Related Links
[Security Identifiers (SIDs) · Microsoft Learn](https://learn.microsoft.com/...)Recommendation: Change to "Related Link" (singular) or add more relevant links, such as:
Based on repository patterns: Articles with multiple links use "Related Articles" (e.g., latency_with_netapp.md:47), while those with a single link should use singular form. Low Priority: Code Block Language SpecificationIssue: The PowerShell code block uses the generic Location: docs/kb/activitymonitor/monitoring-platforms-and-storage/multi-domain-account-exclusions.md:41-47 Current format is acceptable, but consider adding more context: # Get the SID of a specific user from Domain2
Get-ADUser -Identity username -Server domain2 -Properties SID
# Example output:
# DistinguishedName : CN=Michael.Scott,OU=Users,DC=contoso2,DC=com
# SID : S-1-5-21-3693812452-4124425045-3432912480-1163This is a minor point and not required, but it would improve clarity. Low Priority: Instructions FormattingIssue: The numbered steps use a mix of formatting styles. Step 4 has sub-items with indentation inconsistency. Location: docs/kb/activitymonitor/monitoring-platforms-and-storage/multi-domain-account-exclusions.md:50-54 Current: 4. Edit the EXCSIDS line:
- Use semicolon delimiters only...
- Example (**correct** format): `EXCSIDS=...`
- Example (**incorrect** format): `EXCSIDS=...`Recommendation: Use consistent 3-space indentation for nested lists (standard across the repository): 4. Edit the EXCSIDS line:
- Use semicolon delimiters only. Mixed separators (e.g., comma + semicolon) will break parsing.
- Example (**correct** format): `EXCSIDS=S-1-5-17;S-1-5-18;S-1-5-21-3693812452-4124425045-3432912480-1163`
- Example (**incorrect** format): `EXCSIDS=S-1-5-17;S-1-5-18,S-1-5-21-3693812452-4124425045-3432912480-1163`📋 RecommendationsContent Enhancements
Style Consistency
🔒 Security Review✅ No security concerns identified
🧪 Test CoverageN/A - This is documentation, not code. However, consider:
📊 Summary
Required Changes Before Merge:
Recommended Changes:
Overall Assessment: This is a valuable addition to the knowledge base. With the two critical fixes (knowledge_article_id and admonition format), this article will be ready to merge. Great work on providing a clear solution to a complex multi-domain scenario! 🎯 |
docs/kb/activitymonitor/monitoring-platforms-and-storage/multi-domain-account-exclusions.md
Show resolved
Hide resolved
docs/kb/activitymonitor/monitoring-platforms-and-storage/multi-domain-account-exclusions.md
Outdated
Show resolved
Hide resolved
|
The document looks good! You can ignore the doc reviewer stuff - I made some comments suggesting some changes (I want the doc reviewer to do it this way in the future) |
Revised symptom phrasing
Pull Request Review: New KB on Account ExclusionsThank you for this contribution! I've reviewed the KB article and have the following feedback: Overall AssessmentThis is a well-structured KB article that provides clear, actionable guidance for a specific technical scenario. The content is technically sound and follows most repository conventions. Strengths
Documentation Standards & Consistency Issues1. Section Header Inconsistency (Minor)Location: Lines 20-33, 35 Your article uses:
Based on other KB articles in the repository, the standard headers are:
However, "Related Queries" is unique to this article. Other articles use:
Recommendation: Consider whether "Related Queries" should be "Summary" for consistency, or if this is an intentional new section type for this category of articles. 2. Missing Knowledge Article ID (Medium Priority)Location: Frontmatter metadata Your article is missing the knowledge_article_id: kA04u0000000IxYCAU # Example from other articlesAction Required: Add the knowledge article ID if one has been assigned in your tracking system. Content & Technical Improvements3. PowerShell Comment Could Be Clearer (Minor)Location: Lines 45-47 Current: # Example
# Get-ADUser -Identity Michael.Scott -Server contoso2.com -Properties SID
# This will output just the SID, example: S-1-5-21-3693812452-4124425045-3432912480-1163The comment says "This will output just the SID", but Recommendation: Clarify the comment or update the command: # Example - Get the SID from the output
# Get-ADUser -Identity Michael.Scott -Server contoso2.com | Select-Object -ExpandProperty SID
# Or view all properties including SID:
# Get-ADUser -Identity Michael.Scott -Server contoso2.com -Properties SID4. File Path Reference (Minor Enhancement)Location: Line 49 Current: Recommendation: Consider using the pattern from line 35 where you use code formatting for paths. Also, you might want to add a note about whether this path is consistent across all installations or if it could vary. 5. Restart Instructions Location (Minor)Location: Lines 61-63 The restart instructions appear in the middle of the workflow (after saving the file but before checking the UI). Consider whether users need to restart before step 7, or if step 7 should come before the restart. Current flow:
Consider: Does the UI verification require the restart, or could verification happen before restart? Security Considerations6. No Security Concerns ✅The article correctly:
Performance Considerations7. No Performance Issues ✅The article addresses performance implicitly by:
Test CoverageThis is documentation, not code, so traditional test coverage doesn't apply. However: 8. Testing Scenarios (Enhancement Opportunity)Recommendation: Consider adding a "Verification" or "Expected Results" section describing what users should see after completing these steps:
Style & Formatting9. Consistent Use of Bold ✓Good use of bold for UI elements and important terms. 10. Code Block Formatting ✓PowerShell syntax highlighting is correctly specified. 11. List Formatting ✓The numbered steps are clear and properly formatted. Additional Recommendations12. Related Links Section (Enhancement)Location: Lines 71-72 You have one related link. Consider adding:
Summary of Action ItemsMust Fix (before merge):
Should Fix (recommended):
Nice to Have:
ConclusionThis is a high-quality KB article that provides valuable technical guidance. The issues identified are mostly minor consistency items and enhancements. The core technical content is accurate and well-presented. Recommendation: Approve with minor revisions. Great work on documenting this complex cross-domain scenario! 🎯 |
New KB on account exclusions for multidomain environments when there is no domain trust relationship