Skip to content

Commit 0b53319

Browse files
committed
add trouble shooting doc
1 parent fb59c7c commit 0b53319

File tree

3 files changed

+50
-0
lines changed

3 files changed

+50
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ For comprehensive documentation, see the [`./doc/`](./doc/) directory:
9090

9191
- **[Authentication Guide](./doc/AUTHENTICATION_GUIDE.md)**: Complete guide to all authentication methods
9292
- **[Advanced User Guide](./doc/ADVANCED_USER_GUIDE.md)**: In-depth coverage of sync/async operations and customizations
93+
- **[Troubleshooting Guide](./doc/TROUBLESHOOTING.md)**: Solutions for common issues, including Windows long path support
9394
- **[Examples Overview](./examples/EXAMPLES_OVERVIEW.md)**: Detailed overview of all available examples
9495

9596
## 🏗️ For Developers

doc/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ Information for project contributors and maintainers:
3232
- Release process
3333
- Maintenance procedures
3434

35+
### 🔧 [Troubleshooting Guide](./TROUBLESHOOTING.md)
36+
37+
Solutions for common installation and usage issues:
38+
39+
- Windows long path support (required for some Windows users)
40+
3541
## Quick Start
3642

3743
For most users, start with the main [README](../README.md) which covers basic usage.
@@ -42,6 +48,7 @@ For advanced usage patterns, see the [Advanced User Guide](./ADVANCED_USER_GUIDE
4248

4349
## Getting Help
4450

51+
- **Troubleshooting**: Check the [Troubleshooting Guide](./TROUBLESHOOTING.md) for common issues and solutions
4552
- **Examples**: See [examples directory](../examples/examples/) for working code samples
4653
- **Issues**: Report bugs or request features on [GitHub](https://github.com/norwegian-geotechnical-institute/field-manager-python-client/issues)
4754
- **Support**: Contact the development team for assistance

doc/TROUBLESHOOTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Troubleshooting Guide
2+
3+
This guide helps resolve common issues encountered when installing the Field Manager Python Client.
4+
5+
## Windows Long Path Support
6+
7+
**Problem**: Windows users may encounter installation errors due to the 260-character path length limitation:
8+
9+
```
10+
OSError: [Errno 22] Invalid argument: '...'
11+
FileNotFoundError: [Errno 2] No such file or directory
12+
ERROR: Could not install packages due to an EnvironmentError
13+
```
14+
15+
This is particularly common with the field-manager-python-client library due to its nested directory structure.
16+
17+
**Solution**: Enable Windows long path support using PowerShell (requires administrator privileges):
18+
19+
1. **Open PowerShell as Administrator**:
20+
- Right-click Start button → "Windows PowerShell (Admin)"
21+
- Or search for PowerShell, right-click, "Run as administrator"
22+
23+
2. **Run the command**:
24+
```powershell
25+
New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
26+
```
27+
28+
3. **Restart your computer** for changes to take effect
29+
30+
## Getting Help
31+
32+
If you're still experiencing issues:
33+
34+
1. **Check GitHub Issues**: [field-manager-python-client issues](https://github.com/norwegian-geotechnical-institute/field-manager-python-client/issues)
35+
36+
2. **Create a detailed issue** including:
37+
- Operating system and version
38+
- Python version (`python --version`)
39+
- Complete error message
40+
- Steps to reproduce the problem
41+
42+
## Frequently Asked Questions

0 commit comments

Comments
 (0)