This is an automated email from the ASF dual-hosted git repository. dmagda pushed a commit to branch IGNITE-7595 in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/IGNITE-7595 by this push: new 3335d93 Prepared the main page for the documentation 3335d93 is described below commit 3335d93265407f7a1d9d7948e57360a1365427e2 Author: Denis Magda <dma...@gridgain.com> AuthorDate: Mon Oct 5 11:50:56 2020 -0700 Prepared the main page for the documentation --- docs/_data/toc.yaml | 4 ++-- docs/_docs/includes/intro-languages.adoc | 4 +++- docs/_docs/index.adoc | 22 ++++++++++++++++++---- docs/_docs/preface.adoc | 13 ------------- 4 files changed, 23 insertions(+), 20 deletions(-) diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml index d8b1279..a8e045f 100644 --- a/docs/_data/toc.yaml +++ b/docs/_data/toc.yaml @@ -1,5 +1,5 @@ -- title: Preface - url: preface +- title: Documentation Overview + url: index - title: Quick Start Guides items: - title: Java diff --git a/docs/_docs/includes/intro-languages.adoc b/docs/_docs/includes/intro-languages.adoc index b9aa7cf..ee4930f 100644 --- a/docs/_docs/includes/intro-languages.adoc +++ b/docs/_docs/includes/intro-languages.adoc @@ -1,4 +1,6 @@ -Ignite is available for Java, .NET/C#, and {cpp}. The Java version provides the richest API. The .NET/C# and C++ variants may have limited functionality. To make this guide intuitive for all developers, we adhere to the following conventions: +Ignite is available for Java, .NET/C#, {cpp} and other programming languages. The Java version provides the richest API. +The .NET/C#, C++, Python, etc. languages may have limited functionality. To make the Ignite documentation intuitive for all application developers, +we adhere to the following conventions: * The information provided in this documentation applies to all programming languages unless noted otherwise. * Code samples for different languages are provided in different tabs as shown below. For example, if you are a .NET developer, click on the .NET tab in the code examples to see .NET specific code. diff --git a/docs/_docs/index.adoc b/docs/_docs/index.adoc index 6db462c..fcc2814 100644 --- a/docs/_docs/index.adoc +++ b/docs/_docs/index.adoc @@ -1,5 +1,19 @@ ---- -layout: toc ---- - = Apache Ignite Documentation + +Apache Ignite is a horizontally scalable, fault-tolerant distributed in-memory computing platform for building real-time +applications that can process terabytes of data with in-memory speed. + +Ignite documentation introduces you to the project's main capabilities, shows how to use certain features, or how to +approach cluster optimizations and issues troubleshooting. If you are new to Ignite, then start with the +link:docs/latest/quick-start/java[Quick Start Guides], and build the first application in a matter of 5-10 minutes. +Otherwise, select the topic of your interest and have your problems solved, and questions answered. +Good luck with your Ignite journey! + +== Programming Languages +include::includes/intro-languages.adoc[] + +== Ignite Examples + +The Apache Ignite github repository contains a number of runnable examples that illustrate various Ignite functionality. +Refer to the link:{githubUrl}/examples[Examples^] folder in the Ignite code base. +The examples are also available in the binary distribution. diff --git a/docs/_docs/preface.adoc b/docs/_docs/preface.adoc deleted file mode 100644 index 1d03cca..0000000 --- a/docs/_docs/preface.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Preface - -This guide is targeted at developers and architects who create applications on top of Apache Ignite. - -== Programming Languages -include::includes/intro-languages.adoc[] - - -== Ignite Examples - -The Apache Ignite github repository contains a number of runnable examples that illustrate various Ignite functionality. -Refer to the link:{githubUrl}/examples[Examples^] folder in the Ignite code base. -The examples are also available in the binary distribution.