Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IntelliJ Platform Gradle Plugin (2.X) first page only #1357

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Jonatha1983
Copy link
Contributor

Hi

This PR only contains changes on the IntelliJ Platform Gradle Plugin (2.X) page.

Those are my general suggestions and opinions (feel free to disagree 😄 ):

  1. This page at the end will be for all users who want to write a plugin for JB, ide, and I think that for new users, the migration sections and the various linkages to version 1.X can be overwhelming.
    It can start with a note and a link to users who are migrating from previous version pages, but it should not mention migration and 1.X more than that.
  2. The fact that this Gradle plugin is for creating an IDE plugin causes some confusion when using the plugin noun. So, I think it is always better to be very clear about the meaning, even if it is clear for most of the people from the context.
  3. I find that the structure of this specific page is a bit confusing because it has two main topics: Usage and Configuration. When I went over it, I thought that some of the usage parts should be related to the configuration, while some of the configuration parts should be related to the usage. In addition,, the section of the sub-Gradle plugins should be in a separate part dedicated to more internal and in-depth work.

@@ -27,7 27,8 @@ It is a successor of _[](tools_gradle_intellij_plugin.md)_.

## Requirements

IntelliJ Platform Gradle Plugin 2.x requires the following minimal versions:
IntelliJ Platform Gradle Plugin 2.x requires the following **minimal versions**:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the minimal in bold, but I think it will be better to write the ' ' or "and above" next to each requirement

}
```

To apply the IntelliJ Platform Gradle Plugin to a project, you need to add the following:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but I think the user needs to add the gradle portal repository to use the plugin. If I am wrong, this can be reverted.


### Snapshot Release

To use the latest snapshot versions, add the following to the <path>settings.gradle.kts</path> file:
To use the latest snapshot versions of this plugin, add the following to the <path>settings.gradle.kts</path> file:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Between all the definitions and usages of IJ target products and builds with snapshots and releases, this sentence should emphasize that we are talking here about the plugin version

### Attaching Sources

To attach IntelliJ Platform sources in the IDE, the <control>Download sources</control> setting has to be enabled in IDE versions 2023.2 and later.
This option respects the [](tools_intellij_platform_gradle_plugin_gradle_properties.md#downloadSources) property, which is enabled by default.

<tabs>

<tab title="Earlier versions">
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought those should be in chronological order since it started with the 2023.3 tab and then a tab of 2023.2, and jumping to the earlier version is a bit confusing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is in chronological order. Latest version on the left, oldest on the right; this is also consistent with all other such tabs in docs. We assume that plugin developer always upgrade to new IDEs ASAP.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right.
Sorry - I don't know why I thought "Earlier versions" refers to the "newer" version instead of "older" , and I missed the next to the 2023.3

</tabs>

The attaching sources is handed by the Plugin DevKit plugin thus it's recommended to use always the latest available IDE release.
The attaching sources operation in the IDE is handled by the Plugin DevKit plugin thus it's always recommended to use the latest available IDE release.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found this a bit unclear.

The DevKit plugin handled the attaching sources so it is recommended to use the latest plugin version available or the latest IDE release?

@YannCebron YannCebron requested a review from hsz July 29, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants