Skip to content

Commit 2b12075

Browse files
committed
(GH-156) Document Language Server Restart
This commit adds a section to the readme on how to reload the puppet language server, as well as a short gif that shows how to.
1 parent fb54a0a commit 2b12075

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

client/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Create or open any Puppet manifest with the extension `.pp` or `.epp` and the ex
4040

4141
## Feature information
4242

43-
## Hover Support
43+
### Hover Support
4444

4545
Hovering over any resource, class declaration or other Puppet symbol provides instant contextual information. For example, hovering over the resource declaration lists the type name and parameter list, with all relevant help text.
4646

@@ -106,6 +106,14 @@ in the [Visual Studio Code documentation](https://code.visualstudio.com/docs/edi
106106
In the Extensions pane, search for "jpogran-puppet" extension and install it there. You will
107107
get notified automatically about any future extension updates!
108108

109+
## Experience a Problem?
110+
111+
If you haven't see the Problems Pane update in awhile, or hover and intellisense doesn't seem to showing up, and you might not know what to do. Sometimes the Puppet extension can experience problems which cause the language server to crash or not respond. The extension has a way of logging the crash, but there is something you can do to get right back to working: reload the Puppet Language Server.
112+
113+
You can reload the Puppet Lanuguage Server by opening the command palette and starting to type `Puppet`. A list of Puppet commands will appear, select `Puppet: Restart Current Session`. This will restart the Puppet Language Server without reloading VSCode or losing any work currently open in the editor.
114+
115+
(https://raw.githubusercontent.com/jpogran/puppet-vscode/master/client/docs/assets/reload_language_server.gif)
116+
109117
## Reporting Problems
110118

111119
If you're having trouble with the Puppet extension, please follow these instructions

0 commit comments

Comments
 (0)