This repo contains the source of official Gluster documentation rendered at https://docs.gluster.org

Clone this repo:
  1. 4b799b9 Merge pull request #496 from harigowtham/6.5 by hari gowtham · 3 years, 4 months ago master
  2. 2a131c8 Added release notes for 6.5 by hari gowtham · 3 years, 4 months ago
  3. a4602a5 Merge pull request #493 from itisravi/quorum-doc by hari gowtham · 3 years, 4 months ago
  4. c48cd70 update arbiter doc by Ravishankar N · 3 years, 4 months ago
  5. b4b4c9d Merge pull request #1 from gluster/master by Ravishankar N · 3 years, 4 months ago

glusterdocs

Source code to gluster documentation: http://docs.gluster.org/

Important Note: This repo had its git history re-written on 19 May 2016. Please create a fresh fork or clone if you have an older local clone.

Building the docs

If you are on EPEL 7 or Fedora, the first thing you will need is to install mkdocs, with the following command :

#sudo yum install mkdocs

For Fedora 23+ (run the following in root)

#dnf install python-pip
#pip install mkdocs

Then you need to run mkdocs from the root of that repository:

$ mkdocs build

If you see an error about docs_dir when using recent versions of mkdocs , try running additional steps mentioned below:

$ cp ./mkdocs.yml ../
$ cd ..

Edit below entry in the copied mkdocs.yml file

docs_dir: ./glusterdocs/

Then you need to run mkdocs

$ mkdocs build

The result will be in the site/ subdirectory, in HTML.