Admin Guide Edition-Based Migration Plan

Created: 2025-11-06 Status: Planning Phase - DO NOT EXECUTE YET

Summary

This document outlines the plan to reorganize the 31 admin-guide articles into three edition-specific subdirectories:

• essentials/ - Endpoint printing core features (position 1)
• pro-enterprise/ - Advanced features requiring Pro or Enterprise (position 2)
• shared/ - Content applicable to all editions (position 3)

Directory Structure Created

✅ Created three subdirectories:

• /home/andrew/Source/ScrewDriversKB/docs/reference/admin-guide/essentials/
• /home/andrew/Source/ScrewDriversKB/docs/reference/admin-guide/pro-enterprise/
• /home/andrew/Source/ScrewDriversKB/docs/reference/admin-guide/shared/

✅ Created category.json files for each subdirectory with appropriate labels and descriptions.

Migration Mapping

ESSENTIALS EDITION (14 articles)

Core endpoint printing features available in all editions

Current Filename	New Filename	New Position	Reasoning
01-admin-console-overview.md	admin-console-overview.md	1	Admin console is primary interface for Essentials
02-admin-console-main-menu.md	admin-console-main-menu.md	2	UI reference for Essentials admin tasks
03-admin-console-icon-bar.md	admin-console-icon-bar.md	3	UI reference for Essentials admin tasks
04-admin-console-panes.md	admin-console-panes.md	4	UI reference for Essentials admin tasks
05-entities-and-inheritance.md	entities-and-inheritance.md	5	Core concept applicable to all editions, but foundational for Essentials setup
06-managing-objects.md	managing-objects.md	6	Core management tasks for all editions
07-managing-owners.md	managing-owners.md	7	Core management tasks for all editions
08-managing-assignments.md	managing-assignments.md	8	Core management tasks for all editions
09-session-printer-settings.md	session-printer-settings.md	10	Endpoint printer session settings (Essentials core feature)
10-endpoint-client-app.md	endpoint-client-app.md	11	Endpoint client is Essentials core feature
20-endpoint-printer-session-settings.md	endpoint-session-settings.md	20	Endpoint-specific session configuration
30-print-server-overview.md	print-server-overview.md	30	Print server is available in Essentials
31-print-server-failover.md	print-server-failover.md	31	Failover available in Essentials
32-print-server-cloud-connector.md	print-server-cloud-connector.md	32	Cloud connector for all editions

Additional Essentials articles (continuing):

Current Filename	New Filename	New Position	Reasoning
33-print-server-printers.md	print-server-printers.md	33	Managing print server printers (Essentials)
34-print-server-updating.md	print-server-updating.md	34	Print server maintenance (Essentials)
35-print-server-session-settings.md	print-server-session-settings.md	35	Print server session configuration
40-direct-printing-overview.md	direct-printing-overview.md	40	Direct printing available in Essentials
41-direct-printing-configuration.md	direct-printing-configuration.md	41	Direct printing setup (Essentials)
42-direct-printing-session-settings.md	direct-printing-session-settings.md	42	Direct printing session settings

Total: 20 articles to essentials/

PRO-ENTERPRISE EDITION (7 articles)

Advanced features requiring Pro or Enterprise editions

Current Filename	New Filename	New Position	Reasoning
11-scanning-client-app.md	scanning-client.md	10	Scanning requires Pro/Enterprise
21-scanning-session-settings.md	scanning-session-settings.md	11	Scanning session config (Pro/Enterprise only)
50-printer-profiles.md	printer-profiles.md	20	Printer profiles are Pro/Enterprise feature
52-maps-reference.md	maps.md	30	Maps are Pro/Enterprise only (per article: "Pro and Enterprise users")
53-reports-reference.md	reports.md	40	Reports are Enterprise-only (per article: "exclusively for ScrewDrivers Enterprise")
62-data-review-overview.md	data-review.md	50	Data review appears to be Pro/Enterprise (auditing/reporting)
print-job-viewer-filter-syntax.md	print-job-viewer-filter-syntax.md	41	Already in pro-enterprise/, relates to reports

Total: 7 articles to pro-enterprise/

SHARED - ALL EDITIONS (4 articles)

Content applicable across all editions

Current Filename	New Filename	New Position	Reasoning
51-legacy-options.md	legacy-options.md	10	Legacy features (Local/Network printers, PDF printers) apply to all editions
60-appendix-endpoint-troubleshooting.md	endpoint-troubleshooting.md	20	Endpoint troubleshooting applies to all editions using endpoint printing
61-appendix-scanning-troubleshooting.md	scanning-troubleshooting.md	21	Scanning troubleshooting (though scanning is Pro/Enterprise)
70-supporting-apps-overview.md	supporting-apps.md	30	Supporting apps (Connector, Database Connection, Licenses, Logs) available in all editions

Total: 4 articles to shared/

Special Considerations

Articles Requiring Further Clarification

61-appendix-scanning-troubleshooting.md

• Issue: Scanning is Pro/Enterprise only, but troubleshooting appendix could go to either pro-enterprise/ or shared/
• Current placement: shared/ (as appendix-style troubleshooting)
• Alternative: Could move to pro-enterprise/ if we want strict edition separation
• Recommendation: Keep in shared/ for now, as it's an appendix/troubleshooting resource that might be referenced across editions

62-data-review-overview.md

• Issue: Article doesn't explicitly state edition requirements
• Current placement: pro-enterprise/ (auditing/reporting suggests advanced feature)
• Reasoning: Data review/audit capabilities typically associated with Pro/Enterprise features
• Needs verification: Check with product documentation or team to confirm edition availability

Articles with Edition-Specific Content

Some articles may contain sections applicable to multiple editions. Consider these during migration:

1. 05-entities-and-inheritance.md - Core concept but may reference Pro/Enterprise features
2. 06-managing-objects.md - May cover both Essentials and Pro/Enterprise object types
3. 70-supporting-apps-overview.md - Supporting apps may have edition-specific features

Strategy: Place these in the edition where they're most commonly used, then add admonition blocks for edition-specific sections:

:::info[Pro & Enterprise Only]
Advanced audit search is only available in Pro and Enterprise editions.
:::

File Renaming Strategy

Following REFERENCE_STRUCTURE.md guidelines:

• Remove numeric prefixes (01-, 11-, etc.)
• Use descriptive kebab-case names
• Shorten where appropriate for cleaner URLs
• Maintain recognizable connection to original content

Filename Changes

Shortened/Simplified:

• 20-endpoint-printer-session-settings.md → endpoint-session-settings.md (remove redundant "printer")
• 11-scanning-client-app.md → scanning-client.md (remove "app" suffix)
• 60-appendix-endpoint-troubleshooting.md → endpoint-troubleshooting.md (remove "appendix-" prefix)
• 70-supporting-apps-overview.md → supporting-apps.md (remove "overview" suffix)

Kept Descriptive:

• Most other files retain full descriptive names for clarity
• Session settings files keep "session-settings" suffix for clear differentiation

Sidebar Position Strategy

Using gaps of 10 for major groupings to allow easy insertion:

Essentials:

• 1-8: Admin console and management foundation
• 10-11: Endpoint client and session settings
• 20: Endpoint session settings (detailed)
• 30-35: Print server management
• 40-42: Direct printing

Pro-Enterprise:

• 10-11: Scanning client and session settings
• 20: Printer profiles
• 30: Maps
• 40-41: Reports and job viewer
• 50: Data review

Shared:

• 10: Legacy options
• 20-21: Troubleshooting appendices
• 30: Supporting apps

Migration Checklist (DO NOT EXECUTE YET)

• Verify edition assignments with product team
• Confirm data-review is Pro/Enterprise only
• Decide final placement for scanning-troubleshooting
• Create detailed cross-reference update list
• Plan for updating internal links within articles
• Plan for updating frontmatter tags (add edition tags)
• Verify all image paths will remain valid
• Test migration on a single article first
• Document rollback procedure if needed

Next Steps

1. Review this plan with stakeholders
2. Verify edition assignments - especially data-review-overview
3. Update cross-references audit - identify all internal links that will break
4. Create migration script (optional) or manual migration procedure
5. Test with 2-3 articles before full migration
6. Update sidebars.js if needed for new structure
7. Update main admin-guide index.md to reflect new structure

Cross-Reference Impact Analysis

Articles with High Cross-Reference Risk

These articles likely have many internal links that will need updating:

1. 01-admin-console-overview.md - References to all other articles
2. 05-entities-and-inheritance.md - Foundational, likely referenced by many
3. index.md - Main admin guide index will need complete rewrite
4. MIGRATION_NOTES.md - May reference old structure

Link Update Pattern

Old format:

[link text](./11-scanning-client-app.md)

New format (from essentials/ to pro-enterprise/):

[link text](../pro-enterprise/scanning-client.md)

New format (within same folder):

[link text](./scanning-client.md)

Open Questions

1. Is data-review-overview.md actually Pro/Enterprise only?

   • Article doesn't explicitly state edition requirement
   • Auditing features often associated with higher-tier editions
   • Need to verify with product documentation

2. Should scanning-troubleshooting go to pro-enterprise/ or stay in shared/?

   • Currently in shared/ as general troubleshooting resource
   • Scanning itself is Pro/Enterprise only
   • Recommendation: Keep in shared/ as appendix unless strict separation required

3. Do any supporting apps have edition-specific features?

   • Article suggests all are available across editions
   • May have edition-specific tabs or options
   • Should verify before finalizing placement

4. Should we create edition indicators in frontmatter?

   • Add edition: essentials or edition: pro-enterprise tag?
   • Would help with automated filtering/navigation
   • Recommendation: Yes, add to migration checklist

Risk Assessment

Low Risk:

• Creating new directory structure ✅ DONE
• Creating category.json files ✅ DONE
• Moving articles with few cross-references

Medium Risk:

• Updating cross-references within moved articles
• Updating frontmatter tags
• Ensuring image paths remain valid

High Risk:

• Breaking existing external links (if any)
• Incorrect edition assignment causing user confusion
• Missing cross-reference updates causing 404s

Mitigation:

• Test with small subset first (2-3 articles)
• Use grep to find all cross-references before migration
• Verify all changes in local build before committing
• Keep git history clean for easy rollback if needed