Reading The Docs

Reading the Documentation

There are several ways to access the documentation. The options have been listed below.

On the Web

The documentation can be directly viewed on your browser:

https://jinalshah.github.io/devops-images/

Locally on your machine (To Preview as you Write)

Reading the Documentation via your Host Machine

Ensure you are at the root of this repository.

Ensure mkdocs is installed on your machine. If not, you can install it using: python3 -m pip install --upgrade mkdocs-material

mkdocs serve

Then access the documentation on your browser by visiting:

http://localhost:8000

Reading the Documentation via Docker

Option 1

Ensure you are at the root of this repository.

Start a container:

docker run -it --name devops-images-docs -v $PWD:/srv -p 8000:8000 ghcr.io/jinalshah/devops/images/all-devops

Navigate to the /srv directory on the container (where the root of this repository is mapped):

cd /srv

Serve the Documents so that they are accessible from your Host Machine:

mkdocs serve -a 0.0.0.0:8000

Then access the documentation on your browser by visiting:

http://localhost:8000

Option 2

Ensure you are at the root of this repository.

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Then access the documentation on your browser by visiting:

http://localhost:8000

---

Troubleshooting

• If you encounter a port conflict on 8000, either stop the conflicting service or use mkdocs serve -a 0.0.0.0:8080 and visit http://localhost:8080.
• Ensure Docker is running if using the Docker method.
• For any issues, please open an issue on the repository.

Contributing to Documentation

If you spot outdated or missing information, please edit the relevant Markdown files in the docs/ directory and submit a pull request.