diff --git a/Documentation/contributing/development/dev_setup.rst b/Documentation/contributing/development/dev_setup.rst index cbd2710a45a0..af923365a668 100644 --- a/Documentation/contributing/development/dev_setup.rst +++ b/Documentation/contributing/development/dev_setup.rst @@ -38,8 +38,18 @@ contribute to Cilium: +----------------------------------------------------------------------------------+-----------------------------+-------------------------------------------------------------------------------+ + `Docker-Compose `_ | OS-Dependent | N/A (OS-specific) | +----------------------------------------------------------------------------------+-----------------------------+-------------------------------------------------------------------------------+ ++ python3-pip | latest | N/A (OS-specific) | ++----------------------------------------------------------------------------------+-----------------------------+-------------------------------------------------------------------------------+ + +For `unit_testing`, you will need to run ``docker`` without privileges. You can usually achieve this by adding your current user to the ``docker`` group. + +To build the documentation, you will need to install its dependencies: + +:: -To run Cilium locally on VMs, you need: + $ sudo pip3 install -r Documentation/requirements.txt + +Finally, in order to run Cilium locally on VMs, you need: +----------------------------------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ | Dependency | Version / Commit ID | Download Command | @@ -49,12 +59,6 @@ To run Cilium locally on VMs, you need: | `VirtualBox `_ (if not using libvirt) | >= 5.2 | N/A (OS-specific) | +----------------------------------------------------------------------------------+-----------------------+--------------------------------------------------------------------------------+ -Finally, in order to build the documentation, you should have Sphinx installed: - -:: - - $ sudo pip install sphinx - You should start with the `gs_guide`, which walks you through the set-up, such as installing Vagrant, getting the Cilium sources, and going through some Cilium basics.