Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

MkDocs deployment of Ansible Best Practices

Notifications You must be signed in to change notification settings

kblase/Ansible-Best-Practices

 
 

Repository files navigation

Ansible-Best-Practices

Open in GitHub Codespaces Deploy MkDocs to Github pages

A collection of Best Practices for Ansible projects in MkDocs.

How-to Guide

The project contains the source files for an MkDocs project, a Dockerfile is provided which bundles all requirements and displays the resulting content in a webserver.

Clone the project and change into the base directory, afterwards build the image:

docker build -t best-practice-guide .

Start a container from the image, the webserver is available at Port 8080:

docker run -d -p 8080:80/tcp --name ansible-guide best-practice-guide

Go to http://localhost:8080 to view the Best-Practice Guide.

Development

Create a Python virtual environment:

python3 -m venv mkdocs-venv

Activate:

source mkdocs-venv/bin/activate

Install MkDocs dependencies:

pip3 install -r requirements.txt

Run Live-Preview server (available on Port 8000):

mkdocs serve

About

MkDocs deployment of Ansible Best Practices

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • YAML 77.4%
  • Dockerfile 22.6%