Skip to content

Commit

Permalink
chore: update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
f1ames committed Jan 31, 2024
1 parent ddc6097 commit 4ff15ea
Show file tree
Hide file tree
Showing 13 changed files with 39 additions and 6 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Change Log

## 0.9.0

### Features

* Introduced `Fix...` quick action. It allows to automatically fix most of misconfigurations.
* Introduced `Suppress...` quick action. It allows to suppress each rule within a single resource.
* Introduced `Show details...` quick action. It allows to navigate quickly to current misconfiguration in Violations panel.
* Introduced `monokle.automaticallyOpenPanel` configuration option. It allows to define when Violations panel should be shown automatically.

## 0.8.3

### Fixes
Expand Down
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,23 @@ This is **Technical Preview** release. We are open to any feedback and eager to

## Features

### Validate your resources in a blink of an eye

Monokle extension runs in a background and validates all resources within your workspace in real-time. After installing the extension, default policy is used so you are ready to go!

Policy can be changed using [`Monokle: Bootstrap configuration` command](#adjust-to-your-needs) or by [connecting to Monokle Cloud](#monokle-cloudenterprise-integration-setup) to use centralized policy.

### Fix your resources with ease

You can fix most of the problems with Autofix quick action! Just open a quick fix panel and apply "Fix..." action.

<p align="center">
<img src="assets/gifs/autofixes.gif"/>
</p>

### Easily navigate through all errors and resources

Monokle validation panel allows you to easily see all validation errors grouped by resource or rule id, see each rule details and navigate to exact line in each resource where violation was detected.
Monokle validation panel allows you to easily see all validation errors grouped by resource or rule id, see rule details and navigate to exact line in each resource where violation was detected.

<p align="center">
<img src="assets/gifs/navigation.gif"/>
Expand All @@ -48,6 +62,14 @@ Validation runs in a background every time a file is modified and saved. This wa
<img src="assets/gifs/realtime-validation.gif"/>
</p>

### Suppress specific rules for any resource

You can suppress rules for specific resources via "Suppress..." quick fix action. This instructs Monokle extension that the resource is the way you wanted and ignore the rule for this specific resource.

<p align="center">
<img src="assets/gifs/suppress.gif"/>
</p>

### Adjust to your needs

With dedicated `Monokle: Bootstrap configuration` command, you can customize validation configuration in seconds and adjust to your specific needs.
Expand Down Expand Up @@ -139,14 +161,16 @@ After the setup is done, you can run `Monokle: Synchronize` command to speed-up

This extension contributes the following settings:

* `monokle.enable` - Enable/disable this extension.
* `monokle.configurationPath` - Set path to validation configuration file.
* `monokle.verbose` - Log runtime info to VSC Developer Console.
* `monokle.run` - Run resource validation when typing (`onType`) or only when file is saved (`onSave`).
* `monokle.automaticallyOpenPanel` - Open **Violations** panel automatically when project is opened (`onProjectOpen`) or never (`never`).
* `monokle.configurationPath` - Set path to external validation configuration file.
* `monokle.project` - Define remote project from which policy should be used for validation.
* `monokle.origin` - Overwrite default Monokle Cloud URL (e.g. when running own Monokle Enterprise instance).
* `monokle.enabled` - Enable/disable this extension.
* `monokle.telemetryEnabled` - Enable/disable anonymous telemetry.
* `monokle.project` - Define remote project from which policy should be used for validation.
* `monokle.verbose` - Log runtime information to VSC Developer Console.

> **IMPORTANT**: Project id used for `monokle.project` can be obtain on Project details page from current URL `https://app.monokle.com/dashboard/projects/<projectId>`.
> **IMPORTANT**: Project slug used for `monokle.project` can be found in `Project` > `Settings` tab in a `Project slug` field.
## Dependencies

Expand Down
Binary file added assets/gifs/autofixes.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/gifs/configuration.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/gifs/navigation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/gifs/problems.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/gifs/realtime-validation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/gifs/remote-policy-config.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/gifs/remote-policy-sync.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/suppress.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/policies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/repos.png
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 4ff15ea

Please sign in to comment.