wiki/dev_guides/wiki_development_boxes.md

title	author	revision_date
Create live devbox for wiki.rockylinux.org	Lukas Magauer Al Bowles	2022-05-07

How to create a live system to work on the documentation

There are several ways how to setup your development environment, here are the currently used once by the testing team:

Vagrant

For now here is the link to Trevor's vagrant box setup, this might be merged here in the future!

WSL

• Make sure the Windows Subsystem for Linux is enabled on your machine
• Download the Cloud image
• Get the actual disk out of the image (extract rocky-8.5-docker.tar)
• Run wsl --import <machine-name> <path-to-vm-dir> <path-to/rocky-8.5-docker.tar> --version 2 to create the machine
• Run wsl -d <machine-name> to initially login to the machine
• Run dnf -y update to update the system
• Run dnf -y install git python39-pip to install Python 3.9 and pip
• Run python3.9 -m pip install -U pip to update pip
• Clone the repo git clone <path-to-git-project>
• And get into the folder of the repo cd <git-project-name>
• Sometimes you will need to switch the branch here
• Install all the requirements of the repo python3.9 -m pip install -r requirements.txt
• If you just want to look at the output run mkdocs serve 2>&1 | tee ./mkdocs.serve.log

To develop then, the easiest way is to use VS Code with the Remote - WSL, where you have to open the repo in the container (click on the Remote symbol on the lower left, 'Open folder in WSL...').

And finally run mkdocs serve 2>&1 | tee ./mkdocs.serve.log in the terminal of this VS Code session. Then you are ready to start changing stuff!

Docker

From the root of this repository on a machine with Docker installed, run

docker-compose up

When the container finishes starting up, you can access the documentation in your web browser at http://localhost:8000.

{% include 'testing/rc_content_bottom.md' %}