Skip to content
This repository was archived by the owner on May 19, 2022. It is now read-only.

[DOCS] Reorganizes Overview and Installation chapters #9

Merged
merged 1 commit into from
Oct 6, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 2 additions & 29 deletions docs/en/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,6 @@
include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]

== Overview

eland is an open source, Apache2-licensed {es} Python client to analyse, explore
and manipulate data that resides in {es}. Where possible the package uses
existing Python APIs and data structures to make it easy to switch between
Numpy, Pandas, Scikit-learn to their {es} powered equivalents. In general, the
data resides in {es} and not in memory, which allows eland to access large
datasets stored in {es}.

See https://eland.readthedocs.io/en/latest/[eland documentation] for further
details.


=== Installing eland

The source code is currently hosted on GitHub at:
https://github.com/elastic/eland

Binary installers for the latest released version are available at the
https://pypi.org/project/eland[Python package index].

```
pip install eland
```

=== Documentation

Check https://eland.readthedocs.io/en/latest/[the eland documentation site] for
the full documentation and the latest updates.
include::overview.asciidoc[]
include::installation.asciidoc[]

20 changes: 20 additions & 0 deletions docs/en/installation.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[[installation]]
== Installation

Binary installers for the latest released version are available at the
https://pypi.org/project/eland[Python package index].

You can install eland by using pip:

[source,sh]
------------------------------------
pip install eland
------------------------------------

You can also install eland from
https://anaconda.org/conda-forge/eland[Conda Forge] with Conda:

[source,sh]
------------------------------------
conda install -c conda-forge eland
------------------------------------
15 changes: 15 additions & 0 deletions docs/en/overview.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[[overview]]
== Overview

eland is an open source, Apache2-licensed {es} Python client to analyse, explore
and manipulate data that resides in {es}. Where possible the package uses
existing Python APIs and data structures to make it easy to switch between
Numpy, Pandas, Scikit-learn to their {es} powered equivalents. In general, the
data resides in {es} and not in memory, which allows eland to access large
datasets stored in {es}.

The eland source code is hosted on GitHub in
https://github.com/elastic/eland[the eland repository].

Check https://eland.readthedocs.io/en/latest/[the eland documentation site] for
the full documentation and the latest updates.