mirror of
https://github.com/gluster/glusterdocs.git
synced 2026-02-06 00:48:24 +01:00
d07f57cbb6
* Update `Setting Up Volumes.md` - fix order of "Volume Types" list * The "Creating <volume_type> Volumes" sections are in a different order to the list of "Volume Types" at the top of the page. Deprecated volumes (e.g. Striped) are shown before non-deprecated volumes (e.g. Distributed Replicated). * Add links from the "Volume Types" list at the top of the page to their "Creating <volume_type> Volumes" section further down * Removing reference to the 'Striped' volumes in `Setting Up Volumes.md` as they don't work in the latest versions (glusterfs-6.x and glusterfs-7.x)
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 30+ (run the following in root)
# dnf install python-pip
# pip install -r requirements.txt
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.