Skip to content

Commit

Permalink
Remove references to GOPATH in documentation
Browse files Browse the repository at this point in the history
It is no longer nessicary to build or develop Cilium from your GOPATH,
and any directory can be used.

Signed-off-by: James Laverack <james@isovalent.com>
  • Loading branch information
JamesLaverack committed Jun 6, 2023
1 parent c2b5e70 commit f1c4c49
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,10 @@ Clone and Provision Environment
#. Fork the Cilium repository to your GitHub user or organization.
#. Turn off GitHub actions for your fork as described in the `GitHub Docs <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository>`_.
This is recommended to avoid unnecessary CI notification failures on the fork.
#. Clone your ``${YOUR_GITHUB_USERNAME_OR_ORG}/cilium`` fork into your ``GOPATH``, and setup the base repository as ``upstream`` remote:
#. Clone your ``${YOUR_GITHUB_USERNAME_OR_ORG}/cilium`` fork and setup the base repository as ``upstream`` remote:

.. code-block:: shell-session
mkdir -p "${GOPATH}/src/github.com/cilium"
cd "${GOPATH}/src/github.com/cilium"
git clone https://github.com/${YOUR_GITHUB_USERNAME_OR_ORG}/cilium.git
cd cilium
git remote add upstream https://github.com/cilium/cilium.git
Expand Down
4 changes: 2 additions & 2 deletions Documentation/contributing/development/dev_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ If you want to connect to the Kubernetes cluster running inside the developer VM
.. code-block:: shell-session
$ export KUBECONFIG=$KUBECONFIG:$GOPATH/src/github.com/cilium/cilium/vagrant.kubeconfig
$ export KUBECONFIG=$KUBECONFIG:${PATH_TO_CILIUM_REPO}/vagrant.kubeconfig
and add ``127.0.0.1 k8s1`` to your hosts file.
where ``PATH_TO_CILIUM_REPO`` is the path of your local clone of the Cilium git repository. Also add ``127.0.0.1 k8s1`` to your hosts file.
If you have any issue with the provided vagrant box
``cilium/ubuntu`` or need a different box format, you may
Expand Down
8 changes: 1 addition & 7 deletions Documentation/contributing/docs/docstest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,7 @@ For Windows
Preview Documentation Locally
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Navigate to the root of the folder where you cloned the project.

.. code-block:: shell-session
$ cd "${GOPATH}/src/github.com/cilium/cilium"
Run the code below in your terminal:
Navigate to the root of the folder where you cloned the project, then run the code below in your terminal:

.. code-block:: shell-session
Expand Down

0 comments on commit f1c4c49

Please sign in to comment.