1
0
Fork 0

Doc - cleanups (#7685)

This commit is contained in:
Simran 2018-12-06 05:25:31 -08:00 committed by sleto-it
parent e890bdc01a
commit 801bc38ab9
34 changed files with 122 additions and 51 deletions

View File

@ -7,4 +7,8 @@ Administration
- [Replicating Data](ReplicatingData.md)
- [Installing ArangoDB unattended under Windows](NSISSilentMode.md)
- [Migrating 2.8 to 3.0](Migrate2.8to3.0.md)
- [A function to show grants in Arangosh](ShowUsersGrants.md)

View File

@ -9,19 +9,19 @@ You want to modify sources or add your own changes to ArangoDB.
Solution
--------
Arangodb, as many other opensource projects nowadays is standing on the shoulder of giants.
ArangoDB, as many other open source projects nowadays, is standing on the shoulder of giants.
This gives us a solid foundation to bring you a unique feature set, but it introduces a lot of
dependencies that need to be in place in order to compile arangodb.
dependencies that need to be in place in order to compile ArangoDB.
Since build infrastructures are very different depending on the target OS, choose your target
from the recepies below.
from the recipes below.
- [Compile on Debian](Debian.md)
- [Compile on Windows](Windows.md)
- [OpenSSL](OpenSSL.md)
- [Running Custom Build](RunningCustomBuild.md)
- [Recompiling jemalloc](jemalloc.md)
- [OpenSSL 1.1](OpenSSL.md)

View File

@ -28,7 +28,7 @@
* [Replication](Administration/Replication/README.md)
* [Replicating Data](Administration/ReplicatingData.md)
* [Slave Initialization](Administration/Replication/ReplicationFromBackup.md)
* [Silent NSIS on Windows](Administration/NSISSilentMode.md)
* [Silent installation on Windows](Administration/NSISSilentMode.md)
* [Migrating 2.8 to 3.0](Administration/Migrate2.8to3.0.md)
* [Show grants function](Administration/ShowUsersGrants.md)
* [Compiling / Build](Compiling/README.md)

View File

@ -1,2 +1,19 @@
Single Instance
===============
Running a single instance of ArangoDB is the most simple way to get started.
It means to run the ArangoDB Server binary `arangod` stand-alone, without
replication, without failover opportunity and not as cluster together with
other nodes.
You may run multiple processes of `arangod` side-by-side on the same machine as
single instances, as long as they are configured for different ports and data
folders. The official installers may not support multiple installations
side-by-side, but you can get archive packages and unpack them manually.
The provided ArangoDB packages run as single instances out of the box.
See also:
- [Installation](../../../Installation/README.md)
- [Single Instance Deployment](../../../Deployment/SingleInstance/README.md)

View File

@ -5,12 +5,12 @@ Unlike other setups, like the _Active Failover_, _Cluster_, or _Multiple Datacen
which require some specific procedure to be started once the ArangoDB package has
been installed, deploying a single-instance is straightforward.
Depending on your Operating System, after the installation the ArangoDB Server
Depending on your operating system, after the installation the ArangoDB Server
might be already up and running. _Start_, _stop_ and _restart_ operations can be
handled directly using your _System and Service Manager_.
The following are two additional ways that can be used to start the stand-alone
instance:
1. using the [_ArangoDB Starter_](UsingTheStarter.md), or
1. [manually](ManualStart.md).
1. Using the [_ArangoDB Starter_](UsingTheStarter.md), or
2. [manually](ManualStart.md).

View File

@ -1 +1,3 @@
# Monitoring
- [Datacenter to datacenter replication](DC2DC/README.md)

View File

@ -1,2 +1,4 @@
Version 2.1
===========
- [What's New in 2.1](NewFeatures21.md)

View File

@ -1,2 +1,4 @@
Version 2.2
===========
- [What's New in 2.2](NewFeatures22.md)

View File

@ -1,2 +1,5 @@
Version 2.3
===========
- [What's New in 2.3](NewFeatures23.md)
- [Incompatible changes in 2.3](UpgradingChanges23.md)

View File

@ -1,2 +1,5 @@
Version 2.4
===========
- [What's New in 2.4](NewFeatures24.md)
- [Incompatible changes in 2.4](UpgradingChanges24.md)

View File

@ -1,2 +1,5 @@
Version 2.5
===========
- [What's New in 2.5](NewFeatures25.md)
- [Incompatible changes in 2.5](UpgradingChanges25.md)

View File

@ -1,2 +1,5 @@
Version 2.6
===========
- [What's New in 2.6](NewFeatures26.md)
- [Incompatible changes in 2.6](UpgradingChanges26.md)

View File

@ -1,2 +1,5 @@
Version 2.7
===========
- [What's New in 2.7](NewFeatures27.md)
- [Incompatible changes in 2.7](UpgradingChanges27.md)

View File

@ -1,2 +1,5 @@
Version 2.8
===========
- [What's New in 2.8](NewFeatures28.md)
- [Incompatible changes in 2.8](UpgradingChanges28.md)

View File

@ -1,2 +1,5 @@
Version 3.0
===========
- [What's New in 3.0](NewFeatures30.md)
- [Incompatible changes in 3.0](UpgradingChanges30.md)

View File

@ -1,2 +1,5 @@
Version 3.1
===========
- [What's New in 3.1](NewFeatures31.md)
- [Incompatible changes in 3.1](UpgradingChanges31.md)

View File

@ -1,2 +1,6 @@
Version 3.2
===========
- [What's New in 3.2](NewFeatures32.md)
- [Known Issues in 3.2](KnownIssues32.md)
- [Incompatible changes in 3.2](UpgradingChanges32.md)

View File

@ -1,2 +1,6 @@
Version 3.3
===========
- [What's New in 3.3](NewFeatures33.md)
- [Known Issues in 3.3](KnownIssues33.md)
- [Incompatible changes in 3.3](UpgradingChanges33.md)

View File

@ -1,2 +1,6 @@
Version 3.4
===========
- [What's New in 3.4](NewFeatures34.md)
- [Known Issues in 3.4](KnownIssues34.md)
- [Incompatible changes in 3.4](UpgradingChanges34.md)

View File

@ -1,5 +1,5 @@
Known Issues
============
Known Issues in ArangoDB 3.2
============================
The following known issues are present in this version of ArangoDB and will be fixed
in follow-up releases:

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.1
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.1. ArangoDB 2.1 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.2
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.2. ArangoDB 2.2 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.3
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.3. ArangoDB 2.3 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.4
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.4. ArangoDB 2.4 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.5
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.5. ArangoDB 2.5 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.6
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.6. ArangoDB 2.6 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.7
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.7. ArangoDB 2.7 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 2.8
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 2.8. ArangoDB 2.8 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 3.0
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 3.0. ArangoDB 3.0 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 3.1
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 3.1. ArangoDB 3.1 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 3.2
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 3.2. ArangoDB 3.2 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 3.3
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 3.3. ArangoDB 3.3 also contains several bugfixes that are not listed

View File

@ -1,5 +1,5 @@
Features and Improvements
=========================
Features and Improvements in ArangoDB 3.4
=========================================
The following list shows in detail which features have been added or improved in
ArangoDB 3.4. ArangoDB 3.4 also contains several bug fixes that are not listed

View File

@ -1,2 +1,10 @@
Troubleshooting
===============
- [ArangoDB Server (`arangod`)](Arangod.md)
- [Emergency Console](EmergencyConsole.md)
- [Cluster](Cluster/README.md)
- [Datacenter to datacenter replication](DC2DC/README.md)