Skip to content

Commit

Permalink
Merge pull request redhat-developer#19 from JPinkney/master
Browse files Browse the repository at this point in the history
Updated readme and demo with new release
  • Loading branch information
JPinkney authored Jun 22, 2017
2 parents 094eb27 + 3934345 commit d05d950
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 27 deletions.
47 changes: 20 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
[![Build Status](https://travis-ci.org/gorkem/vscode-k8s.svg?branch=master)](https://travis-ci.org/gorkem/vscode-k8s)

# Kubernetes extension for VS Code
VS Code extension that provides assistance for authoring kubernetes
and Openshift configuration.
VS Code extension that provides assistance for authoring kubernetes and Openshift configurations.

## Features
![screencast](https://github.com/JPinkney/vscode-k8s/blob/master/images/demo.gif)

YAML validation:

      Detects whether the entire file is valid yaml

Kubernetes validation:

    Detects errors such as:

      Child node does not exist

      Command not found in kubernetes

      Incorrect type of value

Kubernetes auto completion:

    Auto completes on all commands and resorts to defaults for the value if found
1. YAML validation:
* Detects whether the entire file is valid yaml
2. Kubernetes validation:
* Detects errors such as:
* Node does not exist in kubernetes schema
* Incorrect type of scalar node
* Node is not in a valid location in the file
* Node is not a valid child node of parent
* Detects warnings such as:
* Node is found in schema but not a root node
* Node is an additional property of parent
3. Kubernetes auto completion:
* Auto completes on all commands
* Scalar nodes autocomplete to schema's defaults if they exist
4. Snippets:
* Snippets for creating deployment, deployment config, route, config map, persistent volume claim
5. Additional Commands:
* Commands for allowing the user to turn on/off validation of the specific yaml file they are working on

## Developer Support

Expand Down Expand Up @@ -52,11 +52,4 @@ Kubernetes auto completion:
```bash
code ./server
```
Refer to VS Code [documentation](https://code.visualstudio.com/docs/extensions/debugging-extensions) on how to run and debug the extension

### Configuring the extension for testing
In order to configure the extension for autocompletion you need to change edit.quickSuggestions.strings to true

1. Open up your settings.json file by going to VS code settings
2. Under the editor tab scroll down until you find "editor.quickSuggestions"
3. Edit this and make sure that "strings" is set to true (otherwise autocomplete will not work)
Refer to VS Code [documentation](https://code.visualstudio.com/docs/extensions/debugging-extensions) on how to run and debug the extension
Binary file modified images/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d05d950

Please sign in to comment.