From 84eec72867808edf665d10077007974dc986e1eb Mon Sep 17 00:00:00 2001 From: lumarel Date: Fri, 29 Apr 2022 02:14:41 +0200 Subject: [PATCH] Add documentation for spinning up a documentation devbox --- wiki_development_boxes.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 wiki_development_boxes.md diff --git a/wiki_development_boxes.md b/wiki_development_boxes.md new file mode 100644 index 0000000..9c8ff59 --- /dev/null +++ b/wiki_development_boxes.md @@ -0,0 +1,39 @@ +--- +title: Create live devbox for wiki.rockylinux.org +author: Lukas Magauer +revision_date: 2022-04-28 +--- + +# 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](https://github.com/tcooper/rocky-linux-wikibox), 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](https://github.com/rocky-linux/sig-cloud-instance-images/actions/workflows/build.yml) +- Get the actual disk out of the image (extract rocky-8.5-docker.tar) +- Run `wsl --import --version 2` to create the machine +- Run `wsl -d ` 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 ` +- And get into the folder of the repo `cd ` +- 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](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.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 + +TODO + +{% include 'testing/rc_content_bottom.md' %}