Skip to content

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

License

Notifications You must be signed in to change notification settings

fxwgr/glusterdocs

This branch is 172 commits behind gluster/glusterdocs:master.

Folders and files

NameName
Last commit message
Last commit date
Aug 21, 2020
Aug 7, 2018
Oct 5, 2016
Aug 24, 2018
Aug 7, 2018
Apr 26, 2019
Mar 9, 2020
Aug 9, 2020
Jul 18, 2019

Repository files navigation

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.

About

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

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 100.0%