Skip to content

Commit f2f37c0

Browse files
Updated readme to include images from IJ Marketplace, as recommended.
1 parent 3dd700f commit f2f37c0

File tree

5 files changed

+15
-14
lines changed

5 files changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ are available in `logs` or metrics, so it **cannot validate the whole query** as
1818
When **a connection to the Dynatrace tenant is configured**, the plugin can execute DQL scripts and show the results.
1919
It can also use the connection to show any kind of validation offered by Dynatrace Notebooks.
2020

21-
The plugin **does not aim to replace Dynatrace Notebooks** - it should still be your primary choice when writing DQLs!
21+
The plugin **does not aim to replace Dynatrace Notebooks** it should still be your primary choice when writing DQLs!
2222
The main goal is to provide a good enough environment to work within IntelliJ when storing your DQLs in Git.
23-
In the local-only mode, it does not have nearly as many validations as the real notebook environment,
23+
In the local-only mode, it does not have nearly as many validations as the real notebook environment;
2424
so valid DQL queries written using the plugin can still be invalid after executing them on Notebooks
2525
(although errors should be rather minor).
2626

@@ -33,10 +33,10 @@ The features may not support all functionalities supported by Dynatrace Notebook
3333

3434
#### DQL customization
3535

36-
The plugin offers advanced and *customizable syntax highlighting* - within the code style settings page you can change
36+
The plugin offers advanced and *customizable syntax highlighting* within the code style settings page you can change
3737
most of the colors used for DQL tokens and keywords.
3838

39-
The plugin also provides a lot of code style settings related to indents, spaces and line breaks between DQL tokens.
39+
The plugin also provides a lot of code style settings related to indents, spaces, and line breaks between DQL tokens.
4040
You will now be able to ensure a common style for all `.dql` files stored in your repository.
4141

4242
As a bonus, the plugin also adds support for IntelliJ _inlays_ for unnamed parameters, so it is now much easier to
@@ -46,7 +46,7 @@ see which values belong to which parameter.
4646

4747
The plugin uses IntelliJ references to provide relations between **DQL fields, functions, statements,
4848
and parameters**. You can find usages of a specific field and see where in the query the value was set.
49-
There is also **support for code refactoring**, which makes it straightforward to - for example -
49+
There is also **support for code refactoring**, which makes it straightforward to for example
5050
change a field name everywhere at once.
5151

5252
#### Code completion
@@ -56,13 +56,13 @@ options. It works with:
5656

5757
- **DQL Commands**, with distinction for query-starting commands and operations on the data set.
5858
- **Statement parameters**, with automatically fulfilling their default values.
59-
- **DQL fields** - You'll see all fields used in the query, and if the field's value was overwritten.
59+
- **DQL fields** You'll see all fields used in the query, and if the field's value was overwritten.
6060
It will also show the value within the completion tooltip.
6161
- **DQL functions and their parameters**, with automatically filtering out functions that do not provide a proper
6262
return value for the current context.
63-
- **DQL subqueries**, for commands offering joining functionality.
63+
- **DQL subqueries**, for commands offering to join functionality.
6464

65-
![An example code completion](src/main/resources/docs/images/code-completion.png)
65+
![An example code completion](https://plugins.jetbrains.com/files/28135/screenshot_03be2e47-d3d2-4685-b383-d5c3c134bcd6)
6666

6767
#### DQL functions support
6868

@@ -75,7 +75,7 @@ the plugin will produce a weak warning but ignore its return values and paramete
7575
#### Contextual issues detection
7676

7777
Apart from just validating the DQL file syntax, the plugin is also automatically detecting contextual
78-
issues and - where possible - offering a quick fix to resolve them. It can detect:
78+
issues and where possible offering a quick fix to resolve them. It can detect:
7979

8080
- Invalid commands
8181
- Invalid command parameters: invalid names and values, missing and duplicated parameters, conflicts with other
@@ -85,7 +85,7 @@ issues and - where possible - offering a quick fix to resolve them. It can detec
8585
- Other smaller issues like static values being used in expressions or not-constant values provided where they are
8686
required
8787

88-
![An example error detection](src/main/resources/docs/images/error-detection.png)
88+
![An example error detection](https://plugins.jetbrains.com/files/28135/screenshot_74491594-f2e7-4c1f-aa3d-f13f5ee2d147)
8989

9090
#### Documentation tooltips
9191

@@ -97,9 +97,10 @@ documentation page.
9797
- Parameters documentation (for statements and functions): description, possible values
9898
- Context information for other elements, like DQL fields, variables, boolean types, etc.
9999

100-
![An example documentation tooltips](src/main/resources/docs/images/documentation-tooltips.png)
100+
![An example documentation tooltips](https://plugins.jetbrains.com/files/28135/screenshot_8826dab6-8014-4bb2-9ce4-2a2e836f1ac3)
101101

102-
The plugin also implements structure with navbar for IntelliJ, so it's very easy to track the context of the query.
102+
The plugin also implements structure with navbar for IntelliJ, so it's straightforward to track the context of the
103+
query.
103104

104105
#### Partial DQL support
105106

@@ -125,7 +126,7 @@ DQL query to the tenant.
125126
### Remote features
126127

127128
Apart from local features, the plugin also allows to specify a connection to a set of Dynatrace tenants.
128-
After the connection to the tenant is added, the plugin uses
129+
After the connection to the tenant is added, the plugin uses
129130
[official REST API](https://developer.dynatrace.com/develop/sdks/client-query/) to validate, execute and autocomplete
130131
DQLs.
131132

@@ -143,7 +144,7 @@ tenant.
143144
The results of the query execution will be presented as a table, allowing you to quickly verify if the written query
144145
returns the correct data.
145146

146-
![An example DQL execution](src/main/resources/docs/images/dql-execution.png)
147+
![An example DQL execution](https://plugins.jetbrains.com/files/28135/screenshot_34653d24-43cd-4c28-a917-6a1cd1dac0b5)
147148

148149
#### Live validations
149150

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)