docs: Update the documentation section for the IntelliJ-based IDEs (#…

…2104)

Co-authored-by: Max Leonov <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

.vale.ini

@@ -41,6 +41,7 @@ Vale.Spelling = YES
 Vale.Repetition = NO
 
 # Altering rules severity (error, warning, suggestion)
+CheDocs.ReadabilityGrade = suggestion
 IBM.Annotations = suggestion
 IBM.Slash = warning
 IBM.Usage = suggestion

.vale/styles/Vocab/Che/accept.txt

@@ -50,6 +50,7 @@
 [Uu]ninstallation
 [Uu]nstaged
 [Uu]ntrusted
+[Uu]sing
 [Ww]orkspace|[Ww]orkspaces
 [Yy]eoman
 \.NET
@@ -86,6 +87,7 @@ HTTPS|https
 I/O
 IDE|ide|IDEs
 Intelephense
+IntelliJ
 IntelliJ IDEA
 Java
 Java Lombok

modules/end-user-guide/examples/snip_che-configuring-a-workspace-to-use-intellij-idea-community.adoc

@@ -0,0 +1,6 @@
+[source,yaml,subs="+quotes,macros,attributes"]
+----
+components:
+  - type: cheEditor
+    reference: https://raw.githubusercontent.com/che-incubator/jetbrains-editor-images/meta/che-idea/latest.meta.yaml
+----

modules/end-user-guide/nav.adoc

@@ -31,12 +31,9 @@
 ** xref:publishing-metadata-for-a-vs-code-extension.adoc[]
 ** xref:testing-a-visual-studio-code-extension-in-che.adoc[]
 ** xref:using-alternative-ides-in-che.adoc[]
-*** xref:support-for-jetbrains-ides.adoc[]
-**** xref:using-jetbrains-intellij-idea-community-edition.adoc[]
-**** xref:using-jetbrains-intellij-idea-ultimate-edition.adoc[]
-**** xref:configuring-an-existing-workspace-to-use-intellij-idea.adoc[]
-**** xref:using-jetbrains-webstorm.adoc[]
-**** xref:provisioning-jetbrains-activation-code-for-offline-use.adoc[]
+*** xref:configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform.adoc[]
+**** xref:building-images-for-ides-based-on-the-intellij-platform.adoc[]
+**** xref:provisioning-the-jetbrains-offline-activation-code.adoc[]
 *** xref:support-for-theia-based-ides.adoc[]
 ** xref:adding-tools-to-che-after-creating-a-workspace.adoc[]
 ** xref:using-private-container-registries.adoc[]

modules/end-user-guide/pages/building-images-for-ides-based-on-the-intellij-platform.adoc

@@ -0,0 +1,5 @@
+[id="building-images-for-ides-based-on-the-intellij-platform"]
+:navtitle: Building IDE image
+:keywords: end-user-guide, jetbrains-projector, intellij, images, build
+
+include::partial$assembly_building-images-for-ides-based-on-the-intellij-platform.adoc[]

modules/end-user-guide/pages/configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform.adoc

@@ -0,0 +1,6 @@
+[id="configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform"]
+:navtitle: IntelliJ Platform IDEs
+:keywords: end-user-guide, jetbrains-ides, jetbrains, intellij, ide, intellij-ides, intellij-ide, idea, pycharm
+:page-aliases: support-for-jetbrains-ides, using-jetbrains-intellij-idea-community-edition, using-jetbrains-intellij-idea-ultimate-edition, using-jetbrains-webstorm, configuring-an-existing-workspace-to-use-intellij-idea, using-intellij-based-ides
+
+include::partial$assembly_configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform.adoc[]

modules/end-user-guide/pages/provisioning-the-jetbrains-offline-activation-code.adoc

@@ -0,0 +1,6 @@
+[id="provisioning-the-jetbrains-offline-activation-code"]
+:navtitle: JetBrains offline activation code
+:keywords: end-user-guide, jetbrains-activation-code-for-offline-use
+:page-aliases: provisioning-jetbrains-activation-code-for-offline-use
+
+include::partial$proc_provisioning-the-jetbrains-offline-activation-code.adoc[]

modules/end-user-guide/partials/assembly_building-images-for-ides-based-on-the-intellij-platform.adoc

@@ -0,0 +1,18 @@
+:parent-context-of-building-images-for-ides-based-on-the-intellij-platform: {context}
+
+[id="building-images-for-ides-based-on-the-intellij-platform_{context}"]
+= Building images for IDEs based on the IntelliJ Platform
+
+:context: building-images-for-ides-based-on-the-intellij-platform
+
+This section describes how to build images for link:https://plugins.jetbrains.com/docs/intellij/intellij-platform.html#ides-based-on-the-intellij-platform[IDEs based on the IntelliJ Platform] link:https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html#intellij-platform-based-products-of-recent-ide-versions[version 2020.3].
+
+
+include::partial$proc_building-an-image-for-intellij-idea-community-or-pycharm-community.adoc[leveloffset=+1]
+
+
+include::partial$proc_building-an-image-for-an-ide-based-on-the-intellij-platform.adoc[leveloffset=+1]
+
+
+:context: {parent-context-of-building-images-for-ides-based-on-the-intellij-platform}
+

modules/end-user-guide/partials/assembly_configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform.adoc

@@ -0,0 +1,31 @@
+:parent-context-of-assembly_configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform: {context}
+
+[id="configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform_{context}"]
+= Configuring a workspace to use an IDE based on the IntelliJ Platform
+
+:context: assembly_configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform
+
+This section describes how to configure a workspace to use an link:https://plugins.jetbrains.com/docs/intellij/intellij-platform.html#ides-based-on-the-intellij-platform[IDE based on the IntelliJ Platform].
+
+
+[NOTE]
+.No initial repository checkout when running the {prod-short} Server workspaces engine
+====
+When the {prod-short} instance is running the {prod-short} Server workspaces engine, the workspace starts without an initial checkout of the code repositories referenced in the devfile. 
+
+.Workarounds
+
+* In the IDE, click btn:[Get from VCS] to checkout a repository.
+* To enable the automatic initial checkout of the code repositories in the devfile, use the {devworkspace} engine.
+====
+
+include::partial$proc_configuring-a-workspace-to-use-intellij-idea-community.adoc[leveloffset=+1]
+
+
+include::partial$proc_configuring-a-workspace-to-use-pycharm-community.adoc[leveloffset=+1]
+
+
+include::partial$proc_configuring-a-workspace-to-use-a-custom-image-with-an-ide-based-on-the-intellij-platform.adoc[leveloffset=+1]
+
+
+:context: {parent-context-of-assembly_configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform}

modules/end-user-guide/partials/assembly_using-alternative-ides-in-che.adoc

@@ -7,33 +7,10 @@
 
 :context: using-alternative-ides-in-che
 
-Extending {prod} developer workspaces using different IDEs (integrated development environments) enables:
+{prod} provides a default web IDE to use in the developer workspaces. To use another editor, see:
 
-* Re-purposing the environment for different use cases.
+* xref:configuring-a-workspace-to-use-an-ide-based-on-the-intellij-platform.adoc[]
 
-* Providing a dedicated custom IDE for specific tools.
-
-* Providing different perspectives for individual users or groups of users.
-
-// In the traditional Eclipse IDE world, that was done with RCP applications.
-// find out what's RCP?
-
-{prod} provides a default web IDE to be used with the developer workspaces. This IDE is completely decoupled. You can bring your own custom IDE for {prod}:
-
-* *Built from Eclipse Theia*, which is a framework to build web IDEs. Example: link:https://www.youtube.com/watch?v=B6aCqywKpyY[Sirius on the web].
-
-* *Completely different web IDEs*, such as Jupyter, Eclipse Dirigible, or others. Example: link:https://www.youtube.com/watch?v=VooNzKxRFgw[Jupyter in {prod} workspaces].
-
-.Bringing custom IDE built from Eclipse Theia
-
-* Creating your own custom IDE based on Eclipse Theia.
-* Adding {prod-short}-specific tools to your custom IDE.
-* Packaging your custom IDE into the available editors for {prod-short}.
-// TODO: all bullets needs links to docs
-
-.Bringing your completely different web IDE into {prod-short}
-
-* Packaging your custom IDE into the available editors for {prod-short}.
-// TODO: bullet needs a link to docs
+* xref:support-for-theia-based-ides.adoc[]
 
 :context: {parent-context-of-using-alternative-ides-in-che}