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

LRDOCS-6255 IntelliJ #3966

Merged
merged 6 commits into from Mar 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions developer/reference/articles/tooling/intellij/01-intro.markdown
@@ -0,0 +1,20 @@
---
header-id: intellij
---

# IntelliJ

The
[Liferay IntelliJ plugin](https://plugins.jetbrains.com/plugin/10739-liferay-intellij-plugin)
provides support for @product@ development in
[IntelliJ IDEA](https://www.jetbrains.com/idea/). Liferay's IntelliJ plugin
provides the following built-in features:

- Creating a Liferay Workspace (Gradle and Maven based)
- Creating Liferay projects (Gradle and Maven based)
- @product@ Tomcat/Wildfly server support for project deployment and debugging
- Support for adding line markers for each entity in the service editor
- Syntax checking, highlighting, and code completion (e.g., Bnd and XML files)

In these articles, you'll learn how to install the Liferay IntelliJ plugin and
leverage its features to improve Liferay development with IntelliJ IDEA.
@@ -0,0 +1,47 @@
---
header-id: installing-the-liferay-intellij-plugin
---

# Installing the Liferay IntelliJ Plugin

There are two ways to install the Liferay IntelliJ plugin:

- [via IntelliJ Marketplace](#installing-via-intellij-marketplace)
- [via Zip file](#installing-via-zip-file)

Follow the steps pertaining to your preferred installation process.

## Installing Via IntelliJ Marketplace

1. In IntelliJ, navigate to *File* → *Settings* → *Plugins*.

2. In the Marketplace tab, search for *Liferay* in the provided search bar.

3. Click *Install* next to the Liferay IntelliJ Plugin.

![Figure 1: IntelliJ Marketplace offers a streamlined way to install plugins.](../../../images/intellij-marketplace-installation.png)

4. After the plugin has downloaded, select *Restart IDE*.

Once IntelliJ restarts, the Liferay IntelliJ plugin is installed and ready for
use.

## Installing Via Zip File

1. Navigate to the
[JetBrains' Liferay IntelliJ plugin](https://plugins.jetbrains.com/plugin/10739-liferay-intellij-plugin)
page and download it to your local machine.

2. In IntelliJ, navigate to *File* → *Settings* → *Plugins*.

3. Click the gear icon from the top menu and select *Install Plugin from
Disk...*.

4. Select the Liferay IntelliJ plugin and click *OK*.

5. Navigate to the Installed tab in the top menu and select *Restart IDE*.

Once IntelliJ restarts, the Liferay IntelliJ plugin is installed and ready for
use.

Great job! You're now ready to develop for @product@ in IntelliJ!
@@ -0,0 +1,54 @@
---
header-id: installing-a-server-in-intellij
---

# Installing a Server in IntelliJ

Installing a Liferay server in IntelliJ is easy. In just a few steps, you'll
have your server up and running.

| **Note:** Tomcat and Wildfly are the only supported Liferay app server bundles
| available to install in IntelliJ.

Follow these steps to install your server:

1. Right-click your Liferay Workspace and select *Liferay* → *InitBundle*.

This downloads the @product@ bundle specified in your workspace's
`gradle.properties` file. You can change the default bundle by updating the
`liferay.workspace.bundle.url` property. For example, this is required to
update the default bundle version and/or type (e.g., Wildfly). The
downloaded bundle is stored in the workspace's `bundles` folder.

2. Navigate to the top right Configurations dropdown menu and select *Edit
Configurations*. From here, you can configure your server's run and debug
configurations.

![Figure 1: You have several options to choose from the server dropdown menu.](../../../images/intellij-server-dropdown.png)

3. Click the *Add New Configuration* button
(![Add Config](../../../images/icon-intellij-add-config.png)) and select
*Liferay Server*.

4. Give your server a better name and modify any other configurations, if
necessary. Then select *OK* .

![Figure 2: Set your Liferay server's configurations in the Run/Debug Configurations menu.](../../../images/intellij-run-debug-wizard.png)

Your server is now available in IntelliJ! Make sure to select it in the
Configurations dropdown before executing the configuration buttons (below).

For reference, here's how the IntelliJ configuration buttons work with your
@product@ instance:

- *Start* (![Start Server](../../../images/icon-intellij-start-server.png)):
Starts the server.
- *Stop* (![Stop Server](../../../images/icon-intellij-stop-server.png)): Stops
the server.
- *Debug* (![Debug Server](../../../images/icon-intellij-debug-server.png)):
Starts the server in debug mode. For more information on debugging in
IntelliJ, see the
[IntelliJ Debugging](https://www.jetbrains.com/help/idea/debugging-code.html)
article.

Now you're ready to use your server in IntelliJ!
@@ -0,0 +1,27 @@
---
header-id: updating-liferay-intellij-plugin
---

# Updating Liferay IntelliJ Plugin

If you're already using the Liferay IntelliJ plugin but need to update your
environment, follow the steps below:

1. In IntelliJ, navigate to *File* → *Settings* → *Plugins*.

2. Click the *Updates* tab. If the Liferay IntelliJ plugin is outdated, it will
be listed as an available update.

![Figure 1: Check for updates periodically to ensure you're leveraging the latest features.](../../../images/update-intellij-plugin.png)

3. Click the *Update* button (if available) to update the Liferay IntelliJ
plugin.

4. Once it's downloaded, click the *Restart IDE* button.

![Figure 2: The Available Updates prompt also prints the plugin version to which you're updating.](../../../images/intellij-update-restart.png)

Once IntelliJ restarts, the Liferay IntelliJ plugin is updated and ready for
use.


Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion developer/reference/images/placeholder.txt

This file was deleted.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.