zaphod-black
|
0186349d99
|
Docs: Major README simplification + dedicated troubleshooting guide
Reorganized documentation for better usability and maintenance.
CHANGES:
1. README.md simplified (750 → 243 lines):
- Focused on quick start and essential usage
- Removed redundant step-by-step sections
- Removed duplicate explanations
- Clearer structure with better hierarchy
- Link to dedicated troubleshooting guide
2. New TROUBLESHOOTING.md (comprehensive guide):
- Connection Issues:
- Connection test script usage
- 3-step failure diagnosis
- SSL certificate handling
- Permission Errors:
- Missing Datastore.Backup permission
- PBS web interface and CLI solutions
- Required permissions explained
- Installation Issues:
- Ubuntu 22.04 libssl1.1 missing
- Arch Linux libfuse3 errors
- yay AUR helper installation
- Backup Issues:
- Backups not running diagnostics
- "Skip mount point" explanation
- No space left solutions
- Encryption key problems
- Multi-Target Issues:
- Target connection test failures
- Missing services
- Configuration Issues:
- Whitespace in configuration
- Incomplete configuration warning
- Advanced Troubleshooting:
- Verbose logging
- Manual testing
- PBS server logs
- Network timeout solutions
- Common Misconfigurations:
- Token format examples
- Datastore name case-sensitivity
- Repository string format
- Permission path format
BENEFITS:
- Faster onboarding (README focused on getting started)
- Easier problem-solving (dedicated troubleshooting guide)
- Better maintainability (separate concerns)
- Improved searchability (detailed error solutions)
- Professional documentation structure
README now covers:
- Features and quick start
- Prerequisites (simplified)
- Basic usage
- Multi-target management
- Backup types explained
- Encryption key best practices
- Updating and uninstallation
TROUBLESHOOTING covers:
- All error messages and solutions
- Step-by-step diagnostic procedures
- Advanced configuration options
- Common pitfalls and how to avoid them
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
2025-11-02 00:58:38 -05:00 |
|