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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding contents

Merged
merged 8 commits into from Mar 20, 2018
Merged

Adding contents #87

merged 8 commits into from Mar 20, 2018

Conversation

ice1000
Copy link
Contributor

@ice1000 ice1000 commented Mar 20, 2018

  • More SDK descriptions
  • Remove a section since it's duplicate with another chapter (section < chapter)
  • Add reference for a section since it's duplicate with another subsection (section > subsection)
  • Add Gradle Kotlin DSL "advertisement" 馃槈
  • Migrate some https://-based links to upsource:///

To let user select an SDK, see [ProjectJdksEditor](https://upsource.jetbrains.com/idea-ce/file/idea-ce-8c9022ae739b82b2ee8f3355da98b9bbce2cb915/java/idea-ui/src/com/intellij/openapi/projectRoots/ui/ProjectJdksEditor.java).
To let user select an SDK, see [ProjectJdksEditor](upsource:///java/idea-ui/src/com/intellij/openapi/projectRoots/ui/ProjectJdksEditor.java).

However, it is not recommended to use "SDK" in non-IDEA IDEs. "SDK" is IntelliJ-specific (as well as `ProjectJdksEditor` mentioned above) and doesn't work in PyCharm, RubyMine, etc.
Copy link
Member

@yole yole Mar 20, 2018

Choose a reason for hiding this comment

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

Can you please remove this paragraph? It's incorrect: the SDK infrastructure in the project model is fully supported in all IDEs, and is actively used at least in PyCharm and RubyMine. Only the ProjectJdksEditor is specific to IntelliJ IDEA.

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

Oh..... Ok, let me change this

title: Annotator
---

Syntax highlight on a complete AST is based on [`Annotator`](upsource:///platform/analysis-api/src/com/intellij/lang/annotation/Annotator.java),
Copy link
Member

@yole yole Mar 20, 2018

Choose a reason for hiding this comment

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

This topic doesn't appear to be saying anything new; why add it?

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

Because it's a grey chapter. If you consider it unnecessary, we should remove it, both this file and the "Annotator" subsection in the index.

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

What do you think?

Copy link
Member

@yole yole Mar 20, 2018

Choose a reason for hiding this comment

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

No, there is something to be written for this topic (because annotators make sense not only for custom language developers; there are usecases when an annotator for Java is useful), but I'd rather create a topic only when there is some actual content. Before that, it's OK to leave a placeholder in the TOC.

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

Get.


It's not yet very well-documented but there're many good resources for learning how to write build scripts for an IntelliJ plugin with Kotlin script, like [intellij-rust](https://github.com/intellij-rust/intellij-rust/blob/master/build.gradle.kts), [julia-intellij](https://github.com/ice1000/julia-intellij/blob/master/build.gradle.kts), [covscript-intellij](https://github.com/covscript/covscript-intellij/blob/master/build.gradle.kts) or [zig-intellij](https://github.com/ice1000/zig-intellij/blob/master/build.gradle.kts).

`build.gradle.kts` basically look like:
Copy link
Member

@yole yole Mar 20, 2018

Choose a reason for hiding this comment

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

look -> looks

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

Fixed


After gradle 4.4, gradle starts supporting `build.gradle.kts`, an alternative to `build.gradle` written in Kotlin.

It's not yet very well-documented but there're many good resources for learning how to write build scripts for an IntelliJ plugin with Kotlin script, like [intellij-rust](https://github.com/intellij-rust/intellij-rust/blob/master/build.gradle.kts), [julia-intellij](https://github.com/ice1000/julia-intellij/blob/master/build.gradle.kts), [covscript-intellij](https://github.com/covscript/covscript-intellij/blob/master/build.gradle.kts) or [zig-intellij](https://github.com/ice1000/zig-intellij/blob/master/build.gradle.kts).
Copy link
Member

@yole yole Mar 20, 2018

Choose a reason for hiding this comment

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

I would not make any statements about some technology not being well-documented (it's always subjective, and even if true, will likely change soon).

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

Get

@@ -11,6 +11,8 @@ Create an empty plugin project,
see
[Creating a Plugin Project](/basics/getting_started/creating_plugin_project.md).

**Attention: "module" is IntelliJ-specific.**
Copy link
Member

@yole yole Mar 20, 2018

Choose a reason for hiding this comment

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

Once again this nees to be rephrased. Modules are not IntelliJ-specific; the UI for selecting a module type and creating a module through the project wizard is.

Copy link
Contributor Author

@ice1000 ice1000 Mar 20, 2018

Choose a reason for hiding this comment

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

Get

@ice1000
Copy link
Contributor Author

ice1000 commented Mar 20, 2018

Done.

@yole yole merged commit 6f7086b into JetBrains:master Mar 20, 2018
@yole
Copy link
Member

yole commented Mar 20, 2018

Thanks a lot for your contribution!

@ice1000
Copy link
Contributor Author

ice1000 commented Mar 20, 2018

馃槂 My honor

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