Docs maintenance (#316)

docs maintenance
This commit is contained in:
Jakub Chrzanowski 2020-09-21 17:15:08 +02:00 committed by GitHub
parent cf4f0393f6
commit 2dce0189b9
29 changed files with 17 additions and 36 deletions

View File

@ -1,3 +1,4 @@
## Code of Conduct ## Code of Conduct
This project and the corresponding community is governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). Please make sure you read it. This project and the corresponding community is governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct).
Please make sure you read it.

View File

@ -6,8 +6,8 @@
[![Build](https://github.com/JetBrains/intellij-sdk-docs/workflows/Build/badge.svg)][gh:build] [![Build](https://github.com/JetBrains/intellij-sdk-docs/workflows/Build/badge.svg)][gh:build]
[![Slack](https://img.shields.io/badge/Slack-%23intellij--platform-blue)][jb:slack] [![Slack](https://img.shields.io/badge/Slack-%23intellij--platform-blue)][jb:slack]
Learn how to build plugins using IntelliJ Platform SDK for the [JetBrains products][jb:products] by experimenting with Learn how to build plugins using IntelliJ Platform SDK for the [JetBrains products][jb:products] by experimenting with our code samples.
our code samples. These samples show you how features work and help you jumpstart your plugins. These samples show you how features work and help you jumpstart your plugins.
There is also [IntelliJ Platform Plugin Template][gh:template] project available. There is also [IntelliJ Platform Plugin Template][gh:template] project available.
@ -20,15 +20,13 @@ Previous releases are made available via [tags](https://github.com/JetBrains/int
Code Samples depend on the [IntelliJ Platform SDK][docs] and [Gradle][docs:gradle] as a build system. Code Samples depend on the [IntelliJ Platform SDK][docs] and [Gradle][docs:gradle] as a build system.
The main plugin definition file is stored in the `plugin.xml` file, which is created according The main plugin definition file is stored in the `plugin.xml` file, which is created according to the [Plugin Configuration File documentation][docs:plugin.xml].
to the [Plugin Configuration File documentation][docs:plugin.xml]. It describes definitions of the actions, extensions, It describes definitions of the actions, extensions, or listeners provided by the plugin.
or listeners provided by the plugin.
## Code Samples ## Code Samples
In the following table, you may find all available samples provided in the separated directories as stand-alone In the following table, you may find all available samples provided in the separated directories as stand-alone projects available for running with the Gradle `:runIde` task.
projects available for running with the Gradle `:runIde` task.
| Code Sample | Description | | Code Sample | Description |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Action Basics](./action_basics) | Action and Action Group patterns implementation, adds entries to the Tools menu. | | [Action Basics](./action_basics) | Action and Action Group patterns implementation, adds entries to the Tools menu. |

View File

@ -24,4 +24,3 @@ includeBuild '../settings'
includeBuild '../simple_language_plugin' includeBuild '../simple_language_plugin'
includeBuild '../tool_window' includeBuild '../tool_window'
includeBuild '../tree_structure_provider' includeBuild '../tree_structure_provider'

View File

@ -13,7 +13,7 @@ This Plugin registers the [`PopupDialogAction`][file:PopupDialogAction] action,
Additional features of the plugin: Additional features of the plugin:
- [Using the `<override-text>`][docs:action-override] element in an `<action>` element is demonstrated in the `plugin.xml` declaration to add the `PopupDialogAction` action directly to the `ToolsMenu`. - [Using the `<override-text>`][docs:action-override] element in an `<action>` element is demonstrated in the `plugin.xml` declaration to add the `PopupDialogAction` action directly to the `ToolsMenu`.
- [Localization of action and group][docs:action-locale] `text` and `description` attributes using a `<resource-bundle>` is demonstrated in the declaration to add a new group to the `EditorPopupMenu`. - [Localization of action and group][docs:action-locale] `text` and `description` attributes using a `<resource-bundle>` is demonstrated in the declaration to add a new group to the `EditorPopupMenu`.
### Actions ### Actions

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'comparing_references_inspection' rootProject.name = 'comparing_references_inspection'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'conditional_operator_intention' rootProject.name = 'conditional_operator_intention'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'editor' rootProject.name = 'editor'

View File

@ -28,4 +28,3 @@ patchPluginXml {
sinceBuild = '202' sinceBuild = '202'
untilBuild = '202.*' untilBuild = '202.*'
} }

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'facet' rootProject.name = 'facet'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'framework' rootProject.name = 'framework'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'inspection' rootProject.name = 'inspection'

View File

@ -1,2 +1,2 @@
# Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. # Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
kotlin.code.style=official kotlin.code.style=official

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'kotlin' rootProject.name = 'kotlin'

View File

@ -27,4 +27,4 @@ patchPluginXml {
version = project.version version = project.version
sinceBuild = '202' sinceBuild = '202'
untilBuild = '202.*' untilBuild = '202.*'
} }

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'live_templates' rootProject.name = 'live_templates'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'maxOpenProjects' rootProject.name = 'maxOpenProjects'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'module' rootProject.name = 'module'

View File

@ -1,3 +1,3 @@
## Product Specific Code Samples ## Product Specific Code Samples
Please note, all samples in this folder must be imported into Gradle explicitly as they're not included in the default Gradle composite build. Please note, all samples in this folder must be imported into Gradle explicitly as they're not included in the default Gradle composite build.

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'pycharm' rootProject.name = 'pycharm'

View File

@ -3,7 +3,8 @@
## Quickstart ## Quickstart
Project Model Sample project provides five actions that present data extracted using `ProjectRootManager` instance in the message dialogs. Within the implemented actions, you will be able to: Project Model Sample project provides five actions that present data extracted using `ProjectRootManager` instance in the message dialogs.
Within the implemented actions, you will be able to:
- fetch libraries used in the project, - fetch libraries used in the project,
- retrieve the information about the module details, - retrieve the information about the module details,
- rename the used SDK, - rename the used SDK,

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'project_model' rootProject.name = 'project_model'

View File

@ -27,4 +27,4 @@ patchPluginXml {
version = project.version version = project.version
sinceBuild = '202' sinceBuild = '202'
untilBuild = '202.*' untilBuild = '202.*'
} }

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'project_view_pane' rootProject.name = 'project_view_pane'

View File

@ -27,4 +27,4 @@ patchPluginXml {
version = project.version version = project.version
sinceBuild = '202' sinceBuild = '202'
untilBuild = '202.*' untilBuild = '202.*'
} }

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'projectWizard' rootProject.name = 'projectWizard'

View File

@ -34,4 +34,3 @@ public class DemoSettingsEditor extends SettingsEditor<DemoRunConfiguration> {
myScriptName.setComponent(new TextFieldWithBrowseButton()); myScriptName.setComponent(new TextFieldWithBrowseButton());
} }
} }

View File

@ -1,2 +1 @@
rootProject.name = 'settings' rootProject.name = 'settings'

View File

@ -1,4 +1,3 @@
// Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. // Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
rootProject.name = 'simple_language_plugin' rootProject.name = 'simple_language_plugin'

View File

@ -196,4 +196,4 @@
</value> </value>
</option> </option>
</attributes> </attributes>
</scheme> </scheme>