Add Intellij troubleshooting tips (#4117)

* Add Intellij troubleshooting tips

* Rename doc and link?
This commit is contained in:
Trask Stalnaker 2021-09-14 09:54:34 -07:00 committed by GitHub
parent 8f48dfa875
commit d2794fa231
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 3 deletions

View File

@ -34,9 +34,9 @@ and then you can find the java agent artifact at
`javaagent/build/libs/opentelemetry-javaagent-<version>-all.jar`.
### IntelliJ setup
### IntelliJ setup and troubleshooting
See [IntelliJ setup](docs/contributing/intellij-setup.md)
See [IntelliJ setup and troubleshooting](docs/contributing/intellij-setup-and-troubleshooting.md)
### Style guide

View File

@ -1,4 +1,4 @@
# IntelliJ setup
# IntelliJ setup and troubleshooting
**NB!** Please ensure that Intellij uses the same java installation as you do for building this
project from command line. This ensures that Gradle task avoidance and build cache work properly and
@ -26,3 +26,22 @@ Installation:
Configuration:
![Recommended Settings](save-actions.png)
## Troubleshooting
Occassionally, Intellij gets confused, maybe due to the number of modules in this project,
maybe due ot other reasons. In any case, here's some things that might help:
### Invalidate Caches > "Just restart"
* Go to File > Invalidate Caches...
* Unselect all the options
* Click the "Just restart" link
This seems to fix more issues than just closing and re-opening Intellij :shrug:.
### Delete your `.idea` directory
* Close Intellij
* Delete the `.idea` directory in the root directory of your local repository
* Open Intellij