Skip to content

Commit a848ac8

Browse files
committed
(maint) Document 0.13 release
This commit is a documentation update for the 0.13 release. It adds missing issues to the Changelog, and adds the new features to the README. The new features are documented with text descriptions as well as animated gifs.
1 parent 9ef1a47 commit a848ac8

File tree

6 files changed

+45
-1
lines changed

6 files changed

+45
-1
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
1010

1111
- ([GH-366](https://github.com/lingua-pupuli/puppet-vscode/issues/366)) New Debug Adapter
1212
- ([GH-354](https://github.com/lingua-pupuli/puppet-vscode/issues/354)) Document PDK as source information
13+
- ([GH-385](https://github.com/lingua-pupuli/puppet-vscode/issues/385)) New Outline View, Breadcrumb, and Go to Symbol Features
1314

1415
### Changed
1516

1617
- ([GH-397](https://github.com/lingua-pupuli/puppet-vscode/issues/397)) Updated Puppet Editor Services to version 0.15.0. Change Log is at [https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.15.0](https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.15.0)
1718
- ([GH-373](https://github.com/lingua-pupuli/puppet-vscode/issues/373)) Refactor commands and providers to features
1819
- ([GH-351](https://github.com/lingua-pupuli/puppet-vscode/issues/351)) Updated Puppet Editor Services to version 0.14.0. Change Log is at [https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.14.0](https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.15.0)
1920
- ([GH-323](https://github.com/lingua-pupuli/puppet-vscode/issues/323)) Update readme with gif examples
21+
- ([GH-399](https://github.com/lingua-pupuli/puppet-vscode/issues/399)) Update Puppet loading UI to be more user friendly
2022

2123
### Deprecated
2224

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
- [Syntax highlighting](#syntax-highlighting)
1616
- [Auto completion](#auto-completion)
1717
- [Hover Support](#hover-support)
18+
- [Outline View](#outline-view)
19+
- [Breadcrumbs](#breadcrumbs)
20+
- [Go to Symbol](#go-to-symbol)
1821
- [Code Snippets](#code-snippets)
1922
- [Linting](#linting)
2023
- [Puppet Commands](#puppet-commands)
@@ -50,6 +53,9 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht
5053

5154
- Syntax highlighting
5255
- IntelliSense for resources, parameters and more
56+
- Outline View
57+
- Breadcrumbs
58+
- Go to Symbol
5359
- Linting
5460
- Code snippets
5561
- Go to Definition of functions, types and classes
@@ -85,7 +91,14 @@ You can find instructions and installation links here:
8591
- MacOSX
8692
- Linux
8793

88-
## Usage
94+
## Usage
95+
96+
### Loading indicator
97+
98+
The Puppet extension includes additional information in the form of a tooltip which describes the features that are loaded and still loading during startup.
99+
100+
![loading_status](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/loading_status.gif)
101+
89102

90103
### Syntax Highlighting
91104

@@ -109,6 +122,35 @@ Hovering over any resource, class declaration or other Puppet symbol provides in
109122

110123
![hover_support](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/hover_support.gif)
111124

125+
### Outline View
126+
127+
The new `Outline View` shows the symbol tree of the currently selected Puppet manifest.
128+
129+
Supported symbols:
130+
131+
Symbol | Puppet Class
132+
-- | --
133+
Class | `Puppet::Pops::Model::HostClassDefinition`
134+
Defined Type | `Puppet::Pops::Model::ResourceTypeDefinition`
135+
Attribute | `Puppet::Pops::Model::AttributeOperation`
136+
Variable | `Puppet::Pops::Model::AssignmentExpression`
137+
138+
More symbols are planned to be added.
139+
140+
![outline_view](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/outline_view.gif)
141+
142+
### Breadcrumbs
143+
144+
When the `breadcrumbs.enabled` setting is set to true, both the file path and the symbol tree hierarchy are shown in the Breadcrumb view.
145+
146+
![breadcrumbs](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/breadcrumbs.gif)
147+
148+
### Go to Symbol
149+
150+
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.
151+
152+
![go_to_symbol](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/go_to_symbol.gif)
153+
112154
### Code Snippets
113155

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

docs/assets/breadcrumbs.gif

785 KB
Loading

docs/assets/go_to_symbol.gif

652 KB
Loading

docs/assets/loading_status.gif

491 KB
Loading

docs/assets/outline_view.gif

2.79 MB
Loading

0 commit comments

Comments
 (0)