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:
For now here is the link to Trevor's vagrant box setup, this might be merged here in the future!
Manual setup for WSL and toolbox¶
- 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)
wsl --import <machine-name> <path-to-vm-dir> <path-to/rocky-8.5-docker.tar> --version 2to create the machine
wsl -d <machine-name>to initially login to the machine
- Make sure you have
toolboxinstalled on your system
- Create a toolbox
toolbox create rocky-wiki(on Rocky Linux 8 and 9 machines this will create either a Rocky Linux 8 or 9 toolbox container)
Container setup for both¶
dnf -y updateto update the system
dnf -y install git python39-pipto install Python 3.9 and pip (Python 3.9 is default for Rocky Linux 9, the package is called
python3.9 -m pip install -U pipto update pip
- Clone the repo
git clone <path-to-git-project>
- And get into the folder of the repo
- 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...').
For toolbox just place the repo inside your user profile and you will be able to access it with VS Code inside and outside of the toolbox container.
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!
From the root of this repository on a machine with Docker installed, run
When the container finishes starting up, you can access the documentation in your web browser at http://localhost:8000.
If you have questions with respect to this content or to report concerns regarding the use or misuse content please do not hesitate to contact us at email@example.com.
Rocky Linux and the Rocky Enterprise Software Foundation (RESF) does not make any express or implied warranties, including but not limited to the warranties of non-infringement of any third party intellectual property rights. RESF does not warrant that any pending trademark applications for trademarks of RESF will result in any granted trademark protection. RESF shall not be liable for any claims relating to user's activities falling within the scope of the permission and user hereby agrees to indemnify, defend and hold RESF and its contributors harmless against any such claim.
This work is heavily inspired by the Fedora Release Requirements documents which were made available under Attribution-Share Alike 4.0 International license unless otherwise noted.
This content is licensed under under Attribution-Share Alike 4.0 International license unless otherwise noted.