https://github.com/gluster/glusterdocs

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

Last synced: 22 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/gluster/glusterdocs
• Owner: gluster
• License: mit
• Created: 2015-05-19T06:38:46.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T06:56:16.000Z (6 months ago)
• Last Synced: 2024-08-05T10:20:57.633Z (4 months ago)
• Language: HTML
• Homepage:
• Size: 5.92 MB
• Stars: 346
• Watchers: 40
• Forks: 281
• Open Issues: 64
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: docs/security.md

Awesome Lists containing this project

• awesome-starred - gluster/glusterdocs - This repo contains the source of official Gluster documentation rendered at https://docs.gluster.org (others)

README

        
# 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.

# Building the docs in Docker

Included is a Makefile and a Dockerfile, which enables you to easily build the

docs inside Docker without installing any dependencies on your system.

Simply run the following command to compile the docs:

```sh

make

```

This Makefile recipe builds a Docker image containing the dependencies required

and runs `mkdocs` inside the built image, taking care to run the container as

the current `uid` and `gid` so that your user has ownership of the results in

the `./site` directory.