Merge pull request #87 from jpogran/update-branding

Update Branding
puppetlabs · Jun 27, 2017 · f0fb2ed · f0fb2ed
2 parents fff05bc + 545223a
commit f0fb2ed
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 56 deletions.
diff --git a/client/README.md b/client/README.md
@@ -1,14 +1,14 @@
-<!--
-TODO: Need correct marketplace ID
+
 [![Version](https://vsmarketplacebadge.apphb.com/version/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
 [![Installs](https://vsmarketplacebadge.apphb.com/installs-short/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
--->
 
-![Puppet Logo](images/Puppet-Logo-Amber-sm.png)
+[![Build status](https://ci.appveyor.com/api/projects/status/kwt06e0lgs70us4c?svg=true)](https://ci.appveyor.com/project/jpogran/puppet-vscode) [![Build Status](https://travis-ci.org/jpogran/puppet-vscode.svg?branch=master)](https://travis-ci.org/jpogran/puppet-vscode)
 
 # Puppet Language Support for Visual Studio Code
 
-This extension provides Puppet Language support for [Visual Studio Code](https://code.visualstudio.com/)
+This extension provides Puppet Language support for [Visual Studio Code](https://code.visualstudio.com/).
+
+**It is currently in technical preview, so that we can gather bug reports and find out what new features to add.**
 
 ## Platform support
 
@@ -23,17 +23,16 @@ This extension provides Puppet Language support for [Visual Studio Code](https:/
 - Import from `puppet resource` directly into manifests
 - Node graph preview
 
+
 ![Example of features](docs/assets/language_server.gif)
 
 ## Requirements
 
-- Puppet Agent
-
-[Windows](https://docs.puppet.com/puppet/4.10/install_windows.html)
-
-[MacOSX](https://docs.puppet.com/puppet/4.10/install_osx.html)
+You will need to have Puppet Agent installed in order to fully use this extension. You can find installation links here:
 
-[Linux](https://docs.puppet.com/puppet/4.10/install_linux.html)
+* [Windows](https://docs.puppet.com/puppet/4.10/install_windows.html)
+* [MacOSX](https://docs.puppet.com/puppet/4.10/install_osx.html)
+* [Linux](https://docs.puppet.com/puppet/4.10/install_linux.html)
 
 ## Feature information
 
@@ -48,6 +47,10 @@ Syntax highlighting uses [puppet-lint](https://github.com/rodjek/puppet-lint) an
 
 As part of IntelliSense and Snippets, you can quickly create blocks of code
 
+### Linting
+
+Our validation uses [puppet-lint](https://github.com/rodjek/puppet-lint) to validate the Pupept syntax in all open puppet files. Linting is automatically applied to the document as you edit, without having to save the file first.
+
 ### Puppet Resource
 
 You can import existing resources directly using `puppet resource`
@@ -68,31 +71,40 @@ You can preview the [node graph](https://puppet.com/blog/visualize-your-infrastr
 
 The node graph will appear next to the manifest
 
+## Installing the Extension
 
-## Extension Settings
-
-Coming!
-
-<!-- TODO -->
+You can install the official release of the Puppet extension by following the steps
+in the [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/extension-gallery).
+In the Extensions pane, search for "jpogran-puppet" extension and install it there.  You will
+get notified automatically about any future extension updates!
 
-## Known Issues
+## Reporting Problems
 
-None yet.
+If you're having trouble with the PowerShell extension, please follow these instructions
+to file an issue on our GitHub repository:
 
-## Release Notes
+### 1. File an issue on our [Issues Page](https://github.com/PowerShell/vscode-powershell/issues)
 
-**Note** Not released yet. Work in Progress
+Make sure to fill in the information that is requested in the issue template as it
+will help us investigate the problem more quickly.
 
-### 0.0.3
+### 2. Capture verbose logs and send them to us
 
-Puppet Parser validate linter added
+If you're having an issue with crashing or other erratic behavior, add the following
+line to your User Settings in Visual Studio Code:
 
-### 0.0.2
+```json
+    "puppet.languageserver.debugFilePath": "C:\\Some\\file\\path.txt"
+```
 
-Puppet Resource and Puppet Module commands.
+Restart Visual Studio Code and try to reproduce the problem, then examine the log. If the issue persists please open an issue.
 
-### 0.0.1
+## Maintainers
 
-Initial release of the puppet extension.
+- [James Pogran](https://github.com/jpogran) - [@ender2025](http://twitter.com/ender2025)
+- [Glenn Sarti](https://github.com/glennsarti) - [@glennsarti](http://twitter.com/glennsarti)
+- [Austin Blatt](https://github.com/austb)
 
+## License
 
+This extension is [licensed under the Apache-2.0 License](LICENSE.txt).
diff --git a/client/gulpfile.js b/client/gulpfile.js
@@ -6,7 +6,7 @@ var exec = require('child_process').exec;
 var bump = require('gulp-bump');
 var args = require('yargs').argv;
 
-// The default task (called when you run `gulp` from cli) 
+// The default task (called when you run `gulp` from cli)
 gulp.task('default', ['build']);
 
 gulp.task('clean', function () {
@@ -22,7 +22,7 @@ gulp.task('copy_language_server', function () {
 })
 
 gulp.task('build_extension', function (callback) {
-  exec('node ./node_modules/vsce/out/vsce package',
+  exec('node ./node_modules/vsce/out/vsce package --baseContentUrl https://github.com/jpogran/puppet-vscode/client --baseImagesUrl https://github.com/jpogran/puppet-vscode/client',
     function (err, stdout, stderr) {
       console.log(stdout);
       console.log(stderr);
@@ -41,9 +41,9 @@ gulp.task('bump', function () {
     /// Usage:
     /// 1. gulp bump : bumps the package.json and bower.json to the next minor revision.
     ///   i.e. from 0.1.1 to 0.1.2
-    /// 2. gulp bump --version 1.1.1 : bumps/sets the package.json and bower.json to the 
+    /// 2. gulp bump --version 1.1.1 : bumps/sets the package.json and bower.json to the
     ///    specified revision.
-    /// 3. gulp bump --type major       : bumps 1.0.0 
+    /// 3. gulp bump --type major       : bumps 1.0.0
     ///    gulp bump --type minor       : bumps 0.1.0
     ///    gulp bump --type patch       : bumps 0.0.2
     ///    gulp bump --type prerelease  : bumps 0.0.1-2

diff --git a/client/package.json b/client/package.json
@@ -2,15 +2,20 @@
   "name": "puppet-vscode",
   "displayName": "Puppet",
   "description": "Puppet VSCode extension",
-  "version": "0.0.4",
-  "publisher": "puppet",
-  "license": "Apache-2.0",
-  "icon":"images/Puppet-Logo-Amber-sm.png",
-  "repository":{
+  "version": "0.4.0",
+  "publisher": "jpogran",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "icon": "images/Puppet-Logo-Amber-sm.png",
+  "galleryBanner": {
+    "color": "#000000",
+    "theme": "dark"
+  },
+  "homepage": "https://github.com/jpogran/puppet-vscode",
+  "repository": {
     "type": "git",
     "url": "https://github.com/jpogran/puppet-vscode"
   },
-  "bugs":{
+  "bugs": {
     "type": "git",
     "url": "https://github.com/jpogran/puppet-vscode/issues"
   },
@@ -31,17 +36,27 @@
   ],
   "main": "./out/src/extension",
   "contributes": {
-    "languages": [{
-      "id": "puppet",
-      "aliases": ["Puppet", "puppet"],
-      "extensions": [".pp", ".epp"],
-      "configuration": "./languages/puppet.configuration.json"
-    }],
-    "grammars": [{
-      "language": "puppet",
-      "scopeName": "source.puppet",
-      "path": "./syntaxes/puppet.tmLanguage"
-    }],
+    "languages": [
+      {
+        "id": "puppet",
+        "aliases": [
+          "Puppet",
+          "puppet"
+        ],
+        "extensions": [
+          ".pp",
+          ".epp"
+        ],
+        "configuration": "./languages/puppet.configuration.json"
+      }
+    ],
+    "grammars": [
+      {
+        "language": "puppet",
+        "scopeName": "source.puppet",
+        "path": "./syntaxes/puppet.tmLanguage"
+      }
+    ],
     "snippets": [
       {
         "language": "puppet",
@@ -67,12 +82,13 @@
     ],
     "configurationDefaults": {
       "files.encoding": "utf8",
-      "files.associations":[
-        ".pp", ".epp"
+      "files.associations": [
+        ".pp",
+        ".epp"
       ],
-      "[puppet]":{
+      "[puppet]": {
         "editor.tabSize": 2,
-        "editor.insertSpaces":true,
+        "editor.insertSpaces": true,
         "files.insertFinalNewline": true
       }
     },
@@ -96,12 +112,12 @@
           "description": "The timeout to connect to the local Puppet Language Server"
         },
         "puppet.languageserver.preLoadPuppet": {
-          "type":"boolean",
+          "type": "boolean",
           "default": true,
           "description": "Initalize Puppet and Facter when local Puppet Language Server starts"
         },
         "puppet.languageserver.debugFilePath": {
-          "type":"string",
+          "type": "string",
           "default": "",
           "description": "Set the local Puppet Language Server to send debug information to a file"
         },
@@ -126,13 +142,13 @@
     "vsce": "^1.18.0",
     "gulp": "^3.9.1",
     "gulp-bump": "^2.7.0",
-    "yargs":"^8.0.1",
+    "yargs": "^8.0.1",
     "del": "^2.2.2",
-    "run-sequence":"^1.2.2",
+    "run-sequence": "^1.2.2",
     "@types/node": "^6.0.40",
     "@types/mocha": "^2.2.32"
   },
   "dependencies": {
     "vscode-languageclient": "^3.1.0"
   }
-}
+}