Skip to content
This repository has been archived by the owner on Jan 7, 2022. It is now read-only.

Commit

Permalink
added Documentation section to the installation guide (#6)
Browse files Browse the repository at this point in the history
Summary:
* 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
Pull Request resolved: #6

Reviewed By: Zepheus

Differential Revision: D9803094

Pulled By: mvm3k

fbshipit-source-id: 6b52c91589d9dd1aab02e6d99b4a378059f97656
  • Loading branch information
Mark Marchukov authored and facebook-github-bot committed Sep 13, 2018
1 parent efaf7dd commit c6309fb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 40 deletions.
25 changes: 25 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
39 changes: 0 additions & 39 deletions website/i18n/en.json

This file was deleted.

2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
"rename-version": "docusaurus-rename-version"
},
"devDependencies": {
"docusaurus": "^1.1.5"
"docusaurus": "^1.4.0"
}
}

0 comments on commit c6309fb

Please sign in to comment.