mirror of
https://github.com/gluster/glusterdocs.git
synced 2026-02-05 15:47:01 +01:00
697e734b162ab23da53c1b6df25e754244a061cd
Signed-off-by: N Balachandran <nbalacha@redhat.com>
glusterdocs
Source code to gluster documentation: http://docs.gluster.org/
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.
Description
This repo contains the source of official Gluster documentation rendered at https://docs.gluster.org
Languages
HTML
92.1%
Makefile
4.3%
Dockerfile
3.6%