Skip to content

Commit a366a1b

Browse files
authored
Merge pull request #519 from jpogran/GH-507-document-puppet-version-support
(GH-507)(GH-508) Document Puppet Version Support
2 parents 5c65ec9 + aa93715 commit a366a1b

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht
7575

7676
**It is currently in technical preview, so that we can gather bug reports and find out what new features to add.**
7777

78+
## Supported Puppet Versions
79+
80+
The Puppet Extension for VSCode works with Puppet 4 or higher. Some features will be slower or not work on Puppet 4, and are noted in the section for that feature. See [open source Puppet](https://puppet.com/docs/puppet/5.5/about_agent.html) and [Puppet Enterprise](https://puppet.com/docs/pe/2017.3/getting_support_for_pe.html#supported-puppet-enterprise-versions) lifecycle pages for version support details.
81+
7882
## Requirements
7983

8084
You will need to have the [Puppet Agent](https://puppet.com/docs/puppet/4.10/about_agent.html) or [Puppet Development Kit (PDK)](https://puppet.com/docs/pdk/1.x/pdk.html) installed in order to fully use this extension.
@@ -159,14 +163,16 @@ When the `breadcrumbs.enabled` setting is set to true, both the file path and th
159163

160164
Opening the `Command Palette` and typing the `@` symbol initiates the `Go to Symbol` view which allows you to navigate around inside a Puppet manifest more quickly.
161165

162-
> Note: Puppet 4 is not supported for symbols
166+
> Note: Puppet 4 is not supported
163167
164168
![go_to_symbol](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/go_to_symbol.gif)
165169

166170
### Open Symbol by Name
167171

168172
Pressing `Ctrl+T` (or ⌘T on OSX) will list all [Puppet Custom Types](https://puppet.com/docs/puppet/latest/custom_types.html), [Functions](https://puppet.com/docs/puppet/latest/lang_write_functions_in_puppet.html), [Classes](https://puppet.com/docs/puppet/latest/lang_classes.html) and [Defined Types](https://puppet.com/docs/puppet/latest/lang_defined_types.html) in the workspace. You can then [navigate to the symbol](https://code.visualstudio.com/docs/editor/editingevolved#_open-symbol-by-name) by pressing `Enter`.
169173

174+
> Note: Puppet 4 has limited support
175+
170176
### Code Snippets
171177

172178
As part of IntelliSense and Snippets, you can quickly create templates to automate repetitive series of code.

0 commit comments

Comments
 (0)