-
Notifications
You must be signed in to change notification settings - Fork 31
Replace Salesforce KB links with local KB links in Data Classification docs #349
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
Replace Salesforce KB links with local KB links in Data Classification docs #349
Conversation
PR Review - Replace Salesforce KB Links with Local KB Links✅ Overall AssessmentThis is a well-executed PR that improves documentation maintainability by replacing external Salesforce KB links with internal local references. The change is straightforward and aligns with the migration strategy for knowledge base articles. Code Quality & Best PracticesStrengths:
Issues Identified: 🚨 Critical Issue: Incorrect Link FormatLocation: Problem: The link text still contains the old Salesforce URL while only the link target was updated: [https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA00g000000H9e8CAC.html](/docs/kb/dataclassification/how-to-set-up-single-sign-on-via-microsoft-entra-id-authentication)Expected format: Based on other links in the same file (lines 121-130), internal documentation links should use descriptive link text: [How to Set Up Single Sign-On via Microsoft Entra ID Authentication](/docs/kb/dataclassification/how-to-set-up-single-sign-on-via-microsoft-entra-id-authentication)Impact:
Recommendation: Update the link text to match the KB article title or use a descriptive phrase like "this Knowledge Base article" or "How to Set Up Single Sign-On via Microsoft Entra ID Authentication". Additional ObservationsDocumentation Note in PR DescriptionThe PR description mentions:
However, the actual file changed is:
This appears to be a copy-paste error in the PR description (not affecting the actual code). Performance Considerations✅ No performance concerns - this is a documentation-only change that improves page load times by removing external link dependencies. Security Concerns✅ No security issues. Replacing external links with internal ones actually improves security posture by:
Test CoverageManual Testing Checklist:
Suggested Testing:
RecommendationsRequired Changes:
Suggested Change: -[https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA00g000000H9e8CAC.html](/docs/kb/dataclassification/how-to-set-up-single-sign-on-via-microsoft-entra-id-authentication)
+[How to Set Up Single Sign-On via Microsoft Entra ID Authentication](/docs/kb/dataclassification/how-to-set-up-single-sign-on-via-microsoft-entra-id-authentication)Optional: Positive Notes
Status: 🤖 Review generated with Claude Code |
…n docs - Updated 1 file in dataclassification/5.7 - Replaced helpcenter.netwrix.com Salesforce bundle links with relative /docs/kb/ paths Part of effort to replace 142 broken Salesforce KB references across product docs. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
ac157e7 to
d4df6f2
Compare
Pull Request ReviewSummaryThis PR replaces a broken Salesforce KB link with a local KB article reference in the Data Classification documentation. The change is well-intentioned and follows the pattern of migrating external Salesforce links to internal documentation. ✅ Strengths
|
Pull Request Review ✅SummaryThis PR successfully replaces a Salesforce KB link with a local KB article reference in the Data Classification documentation. The implementation is correct and follows established documentation patterns. ✅ Code Quality & Best PracticesExcellent work on:
Verified:
🔍 Technical AssessmentPotential Bugs: None identified
Performance: ✅ Positive impact
Security: ✅ Improved
Test Coverage: N/A (documentation change)
📝 Documentation QualityContent improvements:
Link structure comparison: Before: [https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA00g000000H9e8CAC.html](https://helpcenter.netwrix.com/bundle/z-kb-articles-salesforce/page/kA00g000000H9e8CAC.html)After: [How to Set Up SSO via Microsoft Entra ID Authentication](/docs/kb/dataclassification/how-to-set-up-single-sign-on-via-microsoft-entra-id-authentication)Much cleaner! 🎯 🎯 Alignment with Repository ConventionsWhile there's no CLAUDE.md file in this repository, the changes follow observed patterns:
📊 Impact AnalysisPositive impacts:
No negative impacts identified 💡 Recommendations for Future WorkWhile this PR is ready to merge as-is, consider these follow-up tasks:
✅ Final VerdictStatus: APPROVED 👍 This PR is ready to merge. All concerns from previous reviews have been addressed:
Great work on migrating these KB articles to local documentation! 🤖 Review generated with Claude Code |
Summary
Replaces broken Salesforce KB links with local KB article references in Data Classification documentation.
Changes
/docs/kb/dataclassification/article-nameExample Fix
Before:
After:
Testing
✅ KB article exists in
/docs/kb/dataclassification/✅ Link uses correct Docusaurus format (no .md extension)
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com