This is an automated email from the ASF dual-hosted git repository.
dmagda 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 5b05901 ignite-13740: fixing formatting issues
5b05901 is described below
commit 5b05901b26a1f7216d8187f82062d8f3bb2a862a
Author: Denis Magda <dma...@gridgain.com>
AuthorDate: Wed Dec 30 14:28:03 2020 -0800
ignite-13740: fixing formatting issues
---
docs/_data/toc.yaml | 3 ++
docs/_docs/ignite-cli-tool.adoc | 39 ++++++++++++++++++++++
docs/_docs/index.adoc | 3 +-
docs/_docs/quick-start/getting-started-guide.adoc | 40 +++--------------------
4 files changed, 49 insertions(+), 36 deletions(-)
diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml
index e991cfb..ed73329 100644
--- a/docs/_data/toc.yaml
+++ b/docs/_data/toc.yaml
@@ -16,4 +16,7 @@
url: index
- title: Getting Started Guide
url: quick-start/getting-started-guide
+- title: Ignite CLI Tool
+ url: ignite-cli-tool
+
diff --git a/docs/_docs/ignite-cli-tool.adoc b/docs/_docs/ignite-cli-tool.adoc
new file mode 100644
index 0000000..79ad4b1
--- /dev/null
+++ b/docs/_docs/ignite-cli-tool.adoc
@@ -0,0 +1,39 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+== Ignite CLI Tool
+
+The Ignite CLI tool uses REST API as a communication protocol between the node
and the CLI,
+allowing you to configure the node.
+
+Below is a list of Ignite CLI tool commands with short descriptions:
+
+[cols="1,3",opts="header", stripes=none]
+|===
+| Command | Description
+| `init` | Installs Ignite core modules locally.
+| `module` | Manages optional Ignite modules and external artifacts.
+| `module list` | Shows the list of available optional Ignite modules.
+| `module add` | Adds an optional Ignite module or an external artifact.
+| `module remove` | Adds an optional Ignite module or an external artifact.
+| `node`| Starts, stops and manages locally running Ignite nodes.
+| `node start` | Starts an Ignite node locally.
+| `node stop` | Stops a locally running Ignite node.
+| `node classpath` | Shows the current classpath used by the Ignite nodes.
+| `node list` | Shows the list of currently running local Ignite nodes.
+| `config`| Inspects and updates Ignite cluster configuration.
+| `config get` | Gets current Ignite cluster configuration values.
+| `config set` | Updates Ignite cluster configuration values.
+|===
diff --git a/docs/_docs/index.adoc b/docs/_docs/index.adoc
index f5337bf..7c0863c 100644
--- a/docs/_docs/index.adoc
+++ b/docs/_docs/index.adoc
@@ -16,7 +16,8 @@
Apache Ignite is a distributed database for in-memory speed and
high-performance computing.
-The technical documentation introduces you to the key capabilities, shows how
to use certain features of the current Apache Ignite version.
+The technical documentation introduces you to the key capabilities, shows how
to use certain features of
+the current Apache Ignite version.
NOTE: Though this alpha release version does not support most of the Apache
Ignite functionality,
it introduces several new features, which are to be accompanied with other
improvements from the
link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[Ignite
Enhancement Proposal,window=_blank] list.
diff --git a/docs/_docs/quick-start/getting-started-guide.adoc
b/docs/_docs/quick-start/getting-started-guide.adoc
index 16bc933..815a14d 100644
--- a/docs/_docs/quick-start/getting-started-guide.adoc
+++ b/docs/_docs/quick-start/getting-started-guide.adoc
@@ -169,42 +169,12 @@ ignite node stop myFirstNode
From here, you may want to:
-* Check out the <<Ignite CLI Tool Commands>> section for more detail on
supported commands.
+* Check out the link:ignite-cli-tool[Ignite CLI Tool] page for more detail on
supported commands.
-* Explore the <<Apache Ignite Configuration>> section to learn more about the
configuration parameters.
-
-
-== Ignite CLI Tool Commands
-
-The Ignite CLI tool uses REST API as a communication protocol between the node
and the CLI,
-allowing you to configure the node.
-
-Below is a list of Ignite CLI tool commands with short descriptions:
-
-[cols="1,3",opts="header", stripes=none]
-|===
-| Command | Description
-| `init` | Installs Ignite core modules locally.
-| `module` | Manages optional Ignite modules and external artifacts.
-| `module list` | Shows the list of available optional Ignite modules.
-| `module add` | Adds an optional Ignite module or an external artifact.
-| `module remove` | Adds an optional Ignite module or an external artifact.
-| `node`| Starts, stops and manages locally running Ignite nodes.
-| `node start` | Starts an Ignite node locally.
-| `node stop` | Stops a locally running Ignite node.
-| `node classpath` | Shows the current classpath used by the Ignite nodes.
-| `node list` | Shows the list of currently running local Ignite nodes.
-| `config`| Inspects and updates Ignite cluster configuration.
-| `config get` | Gets current Ignite cluster configuration values.
-| `config set` | Updates Ignite cluster configuration values.
-|===
-
-
-== Apache Ignite Configuration
-
-
-Apache Ignite uses HOCON configuration format.
-For more detail, please see the
link:https://github.com/lightbend/config/blob/master/HOCON.md[HOCON
documentation,window=_blank].
+//== Apache Ignite Configuration
+//
+//Apache Ignite uses HOCON configuration format.
+//For more detail, please see the
link:https://github.com/lightbend/config/blob/master/HOCON.md[HOCON
documentation,window=_blank].
