1
0
mirror of https://github.com/gluster/glusterdocs.git synced 2026-02-05 15:47:01 +01:00
N Balachandran 6abb0ecbc5 glusterdocs: Made some changes to the Quick Start
- Added a missing step (configure firewall) without
which the peer probe will fail.
- Removed references to the New User guide as I couldn't
find one in the docs.
- Removed a redundant Quick Start Guide entry in
 the Install guide which basically just repeated the steps
 in the other one.
- Renamed "Quick start Guide" to "Quick Start Guide" in
 mkdocs.yml.

Signed-off-by: N Balachandran <nbalacha@redhat.com>
2017-09-13 21:15:03 +05:30
2017-08-28 11:50:50 +05:30
2016-10-05 10:39:36 +02:00
2017-02-19 22:01:04 +01:00

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
Readme MIT 110 MiB
Languages
HTML 92.1%
Makefile 4.3%
Dockerfile 3.6%