From 6df7f0e1c78eb9981afd52cf33ae5448977ae91c Mon Sep 17 00:00:00 2001
From: Mark Marchukov <march@fb.com>
Date: Wed, 12 Sep 2018 15:47:32 -0700
Subject: [PATCH] added Documentation section to the installation guide

* explained how to install Docusaurus and test the doc site locally
* updated Docusaurus dependency to version 1.4.0 (latest)
* removed website/i18n/en.json. That file is auto-generated by Docusaurus:
  https://docusaurus.io/docs/en/translation#custom-translation-strings
---
 docs/installation.md | 25 +++++++++++++++++++++++++
 website/i18n/en.json | 39 ---------------------------------------
 website/package.json |  2 +-
 3 files changed, 26 insertions(+), 40 deletions(-)
 delete mode 100644 website/i18n/en.json

diff --git a/docs/installation.md b/docs/installation.md
index 029d7669583d..a0187c224556 100644
--- a/docs/installation.md
+++ b/docs/installation.md
@@ -67,3 +67,28 @@ cd LogDevice/_build/debug
 cmake -DCMAKE_BUILD_TYPE=Debug ../../logdevice
 make -j$(nproc)
 ```
+
+## Documentation
+
+This web site is created with [Docusaurus](https://docusaurus.io/).
+The simplest way to test documentation changes or changes to the structure
+of the site is to install Docusaurus locally as follows:
+
+* [install Node.js](https://nodejs.org/en/download/)
+* [install Yarn](https://yarnpkg.com/en/docs/install) (a package manager
+for Node)
+
+Docusarus requires Node.js >= 8.2 and Yarn >= 1.5.
+
+* `cd LogDevice/website` (where 'LogDevice' is the root of your local LogDevice
+source tree)
+* `yarn add docusaurus --dev` This will create LogDevice/website/node_modules
+directory with much Javascript. This may also update website/package.json with
+the then-current version number of Docusaurus.
+
+To start a Node.js server and load the doc site in a new browser tab
+`cd LogDevice/website` and run `yarn run start`. To stop the server,
+Ctrl+C the process.
+
+Most of LogDevice documentation lives in `LogDevice/docs`. The API reference
+in `LogDevice/website/static/api` is generated with Doxygen.
diff --git a/website/i18n/en.json b/website/i18n/en.json
deleted file mode 100644
index 08dcb2cbdfc6..000000000000
--- a/website/i18n/en.json
+++ /dev/null
@@ -1,39 +0,0 @@
-{
-  "_comment": "This file is auto-generated by write-translations.js",
-  "localized-strings": {
-    "next": "Next",
-    "previous": "Previous",
-    "tagline": "Distributed storage for sequential data",
-    "API_Intro": "LogDevice API",
-    "Introduction": "Introduction",
-    "Concepts": "LogDevice Concepts and architecture",
-    "Concepts and architecture": "Concepts and architecture",
-    "Config": "Cluster configuration",
-    "Cluster config": "Cluster config",
-    "API_Doxygen": "Reference",
-    "Reference": "Reference",
-    "FirstCluster": "Creating your first cluster",
-    "Creating your first cluster": "Creating your first cluster",
-    "Installation": "Installation",
-    "LDQuery": "LDQuery",
-    "LDShell": "LogDevice Shell (LDShell)",
-    "LogDevice Shell": "LogDevice Shell",
-    "LocalCluster": "Running a local cluster",
-    "Running a local cluster": "Running a local cluster",
-    "Logs": "Logs",
-    "Overview": "Overview",
-    "Settings": "Settings",
-    "Docs": "Docs",
-    "API": "API",
-    "Support": "Support",
-    "Blog": "Blog",
-    "Getting started": "Getting started",
-    "Configuration": "Configuration",
-    "Administration": "Administration"
-  },
-  "pages-strings": {
-    "Help Translate|recruit community translators for your project": "Help Translate",
-    "Edit this Doc|recruitment message asking to edit the doc source": "Edit",
-    "Translate this Doc|recruitment message asking to translate the docs": "Translate"
-  }
-}
diff --git a/website/package.json b/website/package.json
index 2b13af69004e..2b956ae84ae0 100644
--- a/website/package.json
+++ b/website/package.json
@@ -9,6 +9,6 @@
     "rename-version": "docusaurus-rename-version"
   },
   "devDependencies": {
-    "docusaurus": "^1.1.5"
+    "docusaurus": "^1.4.0"
   }
 }