From 7bb1eee21cc71fed1eb954b7d7e068d84d5411e0 Mon Sep 17 00:00:00 2001 From: Evan Tschannen Date: Fri, 16 Nov 2018 16:26:25 -0800 Subject: [PATCH] added a few additional links in our documentation --- documentation/sphinx/source/administration.rst | 5 ++++- documentation/sphinx/source/technical-overview.rst | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/documentation/sphinx/source/administration.rst b/documentation/sphinx/source/administration.rst index 6762ad6f5a..ee69f9d8a2 100644 --- a/documentation/sphinx/source/administration.rst +++ b/documentation/sphinx/source/administration.rst @@ -9,15 +9,18 @@ Administration :hidden: :titlesonly: + configuration moving-a-cluster tls - + This document covers the administration of an existing FoundationDB cluster. We recommend you read this document before setting up a cluster for performance testing or production use. .. note:: In FoundationDB, a "cluster" refers to one or more FoundationDB processes spread across one or more physical machines that together host a FoundationDB database. To administer an externally accessible cluster, you need to understand basic system tasks. You should begin with how to :ref:`start and stop the database `. Next, you should review management of a cluster, including :ref:`adding ` and :ref:`removing ` machines, and monitoring :ref:`cluster status ` and the basic :ref:`server processes `. You should be familiar with :ref:`managing trace files ` and :ref:`other administrative concerns `. Finally, you should know how to :ref:`uninstall ` or :ref:`upgrade ` the database. +FoundationDB also provides a number of different :doc:`configuration ` options which you should know about when setting up a FoundationDB database. + .. _administration-running-foundationdb: Starting and stopping diff --git a/documentation/sphinx/source/technical-overview.rst b/documentation/sphinx/source/technical-overview.rst index 318afeda94..c5dbf29e37 100644 --- a/documentation/sphinx/source/technical-overview.rst +++ b/documentation/sphinx/source/technical-overview.rst @@ -26,6 +26,8 @@ These documents explain the engineering design of FoundationDB, with detailed in * :doc:`testing`: FoundationDB uses a combined regime of robust simulation, live performance testing, and hardware-based failure testing to meet exacting standards of correctness and performance. +* :doc:`kv-architecture` provides a description of every major role a process in FoundationDB can fulfill. + .. toctree:: :maxdepth: 1 :titlesonly: @@ -42,3 +44,4 @@ These documents explain the engineering design of FoundationDB, with detailed in fault-tolerance flow testing + kv-architecture