[ignite-3] branch main updated: IGNITE-18986 Update and enhance DEVNOTES.md (#1767)

[ib...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ibessonov pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git


The following commit(s) were added to refs/heads/main by this push:
     new dae9d8fe9a IGNITE-18986 Update and enhance DEVNOTES.md (#1767)
dae9d8fe9a is described below

commit dae9d8fe9a7dd51fb83a934b346a726432b14a17
Author: Aleksey Demakov <ad...@gmail.com>
AuthorDate: Fri Mar 10 09:12:44 2023 +0300

    IGNITE-18986 Update and enhance DEVNOTES.md (#1767)
---
 DEVNOTES.md | 36 +++++++++++++++++-------------------
 1 file changed, 17 insertions(+), 19 deletions(-)

diff --git a/DEVNOTES.md b/DEVNOTES.md
index acc54b139e..ea30da32be 100644
--- a/DEVNOTES.md
+++ b/DEVNOTES.md
@@ -14,26 +14,28 @@
 ***
 
 
-## Building Ignite
-Ignite follows standard guidelines for multi-module Gradle projects, so it can be easily built using the following command from the project root directory (you can disable the tests when building using `-x test`):
+## Quick Start
+Apache Ignite 3 follows standard guidelines for multi-module Gradle projects, so it can be built by using the following command from the
+project root directory:
 ```
 gradlew clean build
 ```
-Upon build completion, CLI tool can be found be under `modules/cli/build` directory. Use `ignite` on Linux and MacOS, or `ignite.exe` on Windows.
-***
+This command builds a project and performs a few additional actions, for example it also runs tests. The build runs faster if
+these actions are disabled as described in the next section.
 
-# Gradle build
-
-## Prerequisites
-* Java 11 SDK
+To start an ignite-3 instance, package Apache Ignite 3 as described below and then follow [the user guide](https://ignite.apache.org/docs/3.0.0-beta/quick-start/getting-started-guide).
 ***
 
 
 ## Building Ignite
-Ignite follows standard guidelines for multi-module Gradle projects, so it can be easily built using the following command from the project 
-root directory (you can disable the tests when building using `-x test`):
+Apache Ignite 3 follows standard guidelines for multi-module Gradle projects, so it can be built by using the following command from the
+project root directory (the tests are disabled with `-x test -x integrationTest` options):
 ```shell
-./gradlew clean build -x test
+./gradlew clean build -x test -x integrationTest
+```
+For a really fast build some other actions can be disabled too:
+```shell
+./gradlew clean build -x test -x integrationTest -x check -x modernizer
 ```
 ***
 
@@ -129,7 +131,8 @@ artifacts in each module (for example `modules/api/build/docs/javadoc`)
 
 
 ## Setting up IntelliJ Idea project
-You can quickly import Ignite project to your IDE using the root `build.gradle` file. In IntelliJ, choose `Open Project` from the `Quick Start` box or choose `Open...` from the `File` menu and select the root `build.gradle` file.
+You can quickly import Ignite project to your IDE using the root `build.gradle` file. In IntelliJ, choose `Open Project` from the
+`Quick Start` box or choose `Open...` from the `File` menu and select the root `build.gradle` file.
 
 After opening the project in IntelliJ, double check that the Java SDK is properly configured for the project:
 * Open the `File` menu and select `Project Structure...`
@@ -137,13 +140,8 @@ After opening the project in IntelliJ, double check that the Java SDK is properl
 * In the `Project` section, make sure the project language level is set to 11.0 as Ignite makes use of several Java 11
   language features
 
-Ignite uses machine code generation for some of it's modules. To generate necessary production code, build the project using gradle.
-
-Configure Idea code style (for IntelliJ Idea >= 2019):
-* File -> Settings -> Editor -> Code Style -> Scheme -> gear (Show Scheme Actions) -> Import Scheme -> IntelliJ IDEA code style XML
-* Choose: ${igniteProject}/idea/intellij-java-google-style.xml
-* Import schema
-* Reboot IntelliJ Idea
+Apache Ignite 3 uses machine code generation for some of its modules. Occasionally, IDEs may fail to trigger this code generation. In
+this case, run a gradle build command from the command line. Subsequent builds can be performed from IDE without problems.
 ***
 
 ## Code structure