Skip to content

Commit 266f4a2

Browse files
committed
Fix README reference issues
- fix typos - some files&urls were not correctly referenced
1 parent f436b9d commit 266f4a2

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the
3636
### Plugin Structure
3737

3838
```
39-
.
4039
├── .github/ GitHub Actions workflows and Dependabot configuration files
4140
├── gradle
4241
│ └── wrapper/ Gradle Wrapper
@@ -58,11 +57,11 @@ Alternatively, `./gradlew clean runIde` will deploy a Gateway distribution (the
5857
└── settings.gradle.kts Gradle project settings
5958
```
6059

61-
`src` directory is the most important part of the project, the Coder Gateway implementation and the manifest for the plugin – [plugin.xml][file:plugin.xml].
60+
`src` directory is the most important part of the project, the Coder Gateway implementation and the manifest for the plugin – [`plugin.xml`](src/main/resources/META-INF/plugin.xml).
6261

6362
### Gradle Configuration Properties
6463

65-
The project-specific configuration file [gradle.properties][file:gradle.properties] contains:
64+
The project-specific configuration file [`gradle.properties`](gradle.properties) contains:
6665

6766
| Property name | Description |
6867
| --------------------------- |---------------------------------------------------------------------------------------------------------------|
@@ -78,7 +77,7 @@ The project-specific configuration file [gradle.properties][file:gradle.properti
7877
| `javaVersion` | Java language level used to compile sources and generate the files for - Java 11 is required since 2020.3. |
7978
| `gradleVersion` | Version of Gradle used for plugin development. |
8079

81-
The properties listed define the plugin itself or configure the [gradle-intellij-plugin][gh:gradle-intellij-plugin] – check its documentation for more details.
80+
The properties listed define the plugin itself or configure the [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) – check its documentation for more details.
8281

8382
### Testing
8483

@@ -91,18 +90,18 @@ Code quality is monitored with the help of [Qodana](https://www.jetbrains.com/qo
9190
Qodana inspections are accessible within the project on two levels:
9291

9392
- using the [Qodana IntelliJ GitHub Action][docs:qodana-github-action], run automatically within the [Build](.github/workflows/build.yml) workflow,
94-
- with the [Gradle Qodana Plugin][gh:gradle-qodana-plugin], so you can use it on the local environment or any CI other than GitHub Actions.
93+
- with the [Gradle Qodana Plugin](https://github.com/JetBrains/gradle-qodana-plugin), so you can use it on the local environment or any CI other than GitHub Actions.
9594

96-
Qodana inspection is configured with the `qodana { ... }` section in the [Gradle build file][file:build.gradle.kts] and [`qodana.yml`][file:qodana.yml] YAML configuration file.
95+
Qodana inspection is configured with the `qodana { ... }` section in the [Gradle build file](build.gradle.kts) and [`qodana.yml`](qodana.yml) YAML configuration file.
9796

9897
> **NOTE:** Qodana requires Docker to be installed and available in your environment.
9998
10099
To run inspections, you can use a predefined *Run Qodana* configuration, which will provide a full report on `http://localhost:8080`, or invoke the Gradle task directly with the `./gradlew runInspections` command.
101100

102101
A final report is available in the `./build/reports/inspections/` directory.
103102

104-
![Qodana][file:qodana.png]
103+
![Qodana](.github/readme/qodana.png)
105104

106105
### Plugin compatibility
107106

108-
`./gradlew runPluginVerifier` can check the plugin compatibility against the specified Gateway. The integration with Githug Actions is commented until [this gradle intellij plugin issue](https://github.com/JetBrains/gradle-intellij-plugin/issues/1027) is fixed.
107+
`./gradlew runPluginVerifier` can check the plugin compatibility against the specified Gateway. The integration with Github Actions is commented until [this gradle intellij plugin issue](https://github.com/JetBrains/gradle-intellij-plugin/issues/1027) is fixed.

0 commit comments

Comments
 (0)