This is an automated email from the ASF dual-hosted git repository.
ptupitsyn 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 96b8bba33c IGNITE-18176 Update documentation introduction (#1349)
96b8bba33c is described below
commit 96b8bba33c322a0f7ca6277de6b2a2e27a5083fe
Author: IgGusev <[email protected]>
AuthorDate: Thu Nov 17 11:34:34 2022 +0300
IGNITE-18176 Update documentation introduction (#1349)
---
docs/_config.yml | 4 +--
docs/_data/toc.yaml | 2 +-
docs/_docs/index.adoc | 39 ++++++++++++-----------
docs/_docs/installation/deb-rpm.adoc | 30 ++++++++++++++---
docs/_docs/quick-start/getting-started-guide.adoc | 15 +++++----
5 files changed, 57 insertions(+), 33 deletions(-)
diff --git a/docs/_config.yml b/docs/_config.yml
index 93bf632918..c40d67499e 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -14,7 +14,7 @@
# limitations under the License.
exclude: [guidelines.md, "Gemfile", "Gemfile.lock", README.adoc,
"_docs/code-snippets", "_docs/includes", '*.sh']
attrs: &asciidoc_attributes
- version: 3.0.0-alpha1
+ version: 3.0.0-beta
base_url: /docs
stylesdir: /docs/assets/css
imagesdir: /docs
@@ -24,7 +24,7 @@ attrs: &asciidoc_attributes
javaCodeDir: code-snippets/java/src/main/java/org/apache/ignite/snippets
csharpCodeDir: code-snippets/dotnet
githubUrl: https://github.com/apache/ignite/tree/master
- docSourceUrl: https://github.com/apache/ignite/tree/IGNITE-7595/docs
+ docSourceUrl: https://github.com/apache/ignite-3/tree/main/docs
collections:
docs:
permalink: /docs/:path:output_ext
diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml
index 2dda5311b3..317e31ddff 100644
--- a/docs/_data/toc.yaml
+++ b/docs/_data/toc.yaml
@@ -12,7 +12,7 @@
# 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.
-- title: Documentation Overview
+- title: About Apache Ignite 3
url: index
- title: Getting Started Guide
url: quick-start/getting-started-guide
diff --git a/docs/_docs/index.adoc b/docs/_docs/index.adoc
index db48bd3913..b658912881 100644
--- a/docs/_docs/index.adoc
+++ b/docs/_docs/index.adoc
@@ -12,31 +12,34 @@
// 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.
-= Apache Ignite Documentation
+= Apache Apache Ignite 3
-Apache Ignite is a distributed database for high-performance computing with
in-memory speed.
+Apache Ignite 3 is a distributed database for high-performance computing with
in-memory speed.
-The technical documentation introduces you to the key capabilities, shows how
to use certain features of
-the current Apache Ignite version.
+Apache Ignite 3 brings a number of improvements compared to Apache Ignite 2:
-NOTE: Though this beta release version does not support most of the Apache
Ignite 2 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.
+* **Industry-standard libraries**: Apache Ignite 3 switches from custom
libraries used in Apache Ignite 2 towards industry-standard libraries, bringing
the latest developments from all over the world to your environment.
+- SWIM replaces Ring and Discovery protocols, bringing even better stability
and performance on large topologies.
+- Raft replaces Ignite replication, providing an improved consensus algorithm,
out of the box split brain protection and much more.
+- SQL Calcite replaces H2 engine used in Apache Ignite 2.
+* **Pluggable storages**: With Apache Ignite 3, you can choose the best
storage for your needs. With this beta release you can choose between page
memory and RocksDB, and more options may be added later.
+* **New transaction protocol**: Apache Ignite 3 provides a new custom protocol
for handling transactions, built up on previous experience with Apache Ignite
2. It brings multiple features such as read-only transactions, SQL transactions
and much more.
+* **Dynamic configuration**: HOCON configuration replaces XML-based
configuration of Apache Ignite 2. All configuration properties can now be
changed at runtime as well, by using API or command-line tool.
+* **Ignite CLI tool**: The new Apache Ignite tool that functions as a single
sign-on for any operational, management, and development needs.
+* See a
link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[full
list of improvements,window=_blank].
-This beta version of Apache Ignite, incorporating all the best solutions over
the past years,
-possesses the highest level of usability thanks to the following improvements:
+== Known Beta 1 Limitations
-* Schema-first approach: This feature introduces one-to-one mapping between
data schemas and caches/tables, which means that the schema is defined for a
cache/table before its creation.
-* Unified Configuration: This feature is presented by a set of the following
improvements:
-- Platform-agnostic configuration representation
-- Clear separation between configuration and any third-party code
-- Predictable configuration lifecycle
-- Consistent runtime configuration change support
-* Ignite CLI tool: This tool functions as a single sign-on for any
operational, management, and development needs.
-* See a
link:https://cwiki.apache.org/confluence/display/IGNITE/Proposals+for+Ignite+3.0[full
list of improvements,window=_blank].
+Some features are not fully implemented in beta. These features are expected
to be working in full release:
+
+- Scaling the cluster is not fully implemented. You can add tables to the
topology or remove them from it, but not scale up an existing table.
+- Operations performed on unstable topology are not guaranteed to be reliable.
+- Restarting the running cluster is not fully implemented - restart under load
is not reliable, additionally the restart must be performed in correct order -
first stopping partition nodes, then metastore, and finally cluster management
group, and bringing them up in reverse order.
+- Database vacuuming is not implemented.
-== New in Beta
+== New in Beta 1
-Apache Ignite 3 Beta release includes the following features:
+Apache Ignite 3 Beta 1 release includes the following features:
- RPM and DEB packages: simplified installation and node management
diff --git a/docs/_docs/installation/deb-rpm.adoc
b/docs/_docs/installation/deb-rpm.adoc
index fff1703d5e..6c161a4f85 100644
--- a/docs/_docs/installation/deb-rpm.adoc
+++ b/docs/_docs/installation/deb-rpm.adoc
@@ -41,22 +41,42 @@ Apache Ignite can be installed from the official
link:https://www.apache.org/dis
+
[tabs]
--
-tab:Unix[]
+tab:deb[]
[source,shell]
----
-curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-cli_3.0.0-beta1_all.deb";
-o ignite3-cli_3.0.0-beta1_all.deb
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-cli_3.0.0~beta1_all.deb";
-o ignite3-cli_3.0.0-beta1_all.deb
-curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-db_3.0.0-beta1_all.deb";
-o ignite3-db_3.0.0-beta1_all.deb
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-db_3.0.0~beta1_all.deb";
-o ignite3-db_3.0.0-beta1_all.deb
+----
+
+tab:RPM[]
+[source,shell]
+----
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-cli-3.0.0~beta1.noarch.rpm";
-o ignite3-cli-3.0.0~beta1.noarch.rpm
+
+curl -L
"https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-beta1/ignite3-db-3.0.0~beta1.noarch.rpm";
-o ignite3-db-3.0.0~beta1.noarch.rpm
----
--
-NOTE: RPM packages are available as `ignite3-cli-3.0.0-beta1.noarch.rpm` and
`ignite3-db-3.0.0-beta1.noarch.rpm`.
Install the Apache Ignite 3 package:
+[tabs]
+--
+tab:deb[]
[source, shell]
----
sudo apt install ignite3-db_3.0.0-beta1_all.deb --no-install-recommends
sudo apt install ignite3-cli_3.0.0-beta1_all.deb --no-install-recommends
-----
\ No newline at end of file
+----
+
+tab:RPM[]
+[source,shell]
+----
+sudo rpm -i ignite3-db-3.0.0~beta1.noarch.rpm
+
+sudo rpm -i ignite3-cli-3.0.0~beta1.noarch.rpm
+----
+
+--
\ No newline at end of file
diff --git a/docs/_docs/quick-start/getting-started-guide.adoc
b/docs/_docs/quick-start/getting-started-guide.adoc
index cddb4741ba..1536fe421d 100644
--- a/docs/_docs/quick-start/getting-started-guide.adoc
+++ b/docs/_docs/quick-start/getting-started-guide.adoc
@@ -29,20 +29,20 @@ include::../includes/prereqs.adoc[]
== Starting Ignite Node
-In this guide we will use a link:../installation/installing-using-zip[zip]
archive installation. To start an Ignite node,
+In this guide we will use a link:../installation/installing-using-zip[zip]
archive installation. To start an Ignite node, go to the
`ignite3-db-3.0.0-beta1` folder and run the following command:
[tabs]
--
tab:Linux[]
----
-ignite3-db-3.0.0-beta1/bin/ignite3db start
+bin/ignite3db start
----
tab:Windows[]
NOTE: You need to install Java in Bash environment to run Ignite on Windows.
----
-bash ignite3-db-3.0.0-beta1/bin/ignite3db start
+bash bin\ignite3db start
----
--
@@ -61,7 +61,7 @@ Ignite CLI is a single entry point for all the Ignite
operations. In this guide
--
tab:Linux[]
----
-ignite3-cli-3.0.0-beta1\bin\ignite3
+ignite3-cli-3.0.0-beta1/bin/ignite3
----
tab:Windows[]
@@ -76,19 +76,19 @@ After you start the node, you can start working on it. For
example, you can perf
== Stopping the Cluster
-After you are done working on the cluster, you need to stop the node. Use the
command below:
+After you are done working on the cluster, you need to stop the node. Go to
the `ignite3-db-3.0.0-beta1` folder and run the following command:
[tabs]
--
tab:Linux[]
----
-ignite3-db-3.0.0-beta1/bin/ignite3db stop
+bin/ignite3db stop
----
tab:Windows[]
----
-bash ignite3-db-3.0.0-beta1/bin/ignite3db stop
+bash bin\ignite3db stop
----
--
@@ -97,6 +97,7 @@ bash ignite3-db-3.0.0-beta1/bin/ignite3db stop
From here, you may want to:
* Check out the link:ignite-cli-tool[Ignite CLI Tool] page for more detail on
supported commands.
+* Try out our
link:https://github.com/apache/ignite-3/tree/main/examples[examples].
//== Apache Ignite Configuration
//
