Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Minor adjustments to the development dependencies #10697

Merged
merged 2 commits into from Mar 25, 2020
Merged

docs: Minor adjustments to the development dependencies #10697

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91bd714
docs: Update requirements for documentation
pchaigno Mar 25, 2020
4d2ef68
docs: Clarify need to run docker as non-root user
pchaigno Mar 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 11 additions & 7 deletions Documentation/contributing/development/dev_setup.rst
View file
Open in desktop
Expand Up @@ -38,8 +38,18 @@ contribute to Cilium:
+----------------------------------------------------------------------------------+-----------------------------+-------------------------------------------------------------------------------+
+ `Docker-Compose <https://docs.docker.com/compose/install/>`_ | 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 |
Expand All @@ -49,12 +59,6 @@ To run Cilium locally on VMs, you need:
| `VirtualBox <https://www.virtualbox.org/wiki/Downloads>`_ (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.
Expand Down