Merge pull request #103 from polycube-network/pr/improve_developers_documentation

improve developers documentation

Author: frisso

Documentation/codegen.rst

@@ -35,7 +35,7 @@ You may choose either of the below options.
 -------------------------------
 - The fastest mode to test ``pcn-k8s`` including setup.
 
-**Pre-requisite:** 
+**Pre-requisite:**
 
 Download and set up the following packages.
 
@@ -113,14 +113,14 @@ You should see something like:
     kube-system   kube-scheduler-k8s-master            1/1       Running   0          1m
 
 
-``pcn-k8s`` requires an ``etcd`` deployment to work, set the ``etcd_url`` parameter in :scm_web_file:`pcn-k8s.yaml <src/components/k8s/pcn-k8s.yaml>`.
-:scm_web_file:`standalone_etcd.yaml <src/components/k8s/standalone_etcd.yaml>` provides a basic etcd service that can be used for testing, deploy it before deploying pcn-k8s.
+``pcn-k8s`` requires an ``etcd`` deployment to work, set the ``etcd_url`` parameter in :scm_raw_web:`pcn-k8s.yaml <src/components/k8s/pcn-k8s.yaml>`.
+:scm_raw_web:`standalone_etcd.yaml <src/components/k8s/standalone_etcd.yaml>` provides a basic etcd service that can be used for testing, deploy it before deploying pcn-k8s.
 
 At this point you can install ``pcn-k8s``:
 
 .. parsed-literal::
 
-    kubectl apply -f |SCM_WEB|/src/components/k8s/pcn-k8s.yaml
+    kubectl apply -f |SCM_RAW_WEB|/src/components/k8s/pcn-k8s.yaml
     # It will take some time until the images are pulled.
 
     # Optional: if you want to execute pods on the master node
@@ -151,7 +151,7 @@ In order to remove ``pcn-k8s`` execute on the master node:
 
 .. parsed-literal::
 
-    kubectl delete -f |SCM_WEB|/src/components/k8s/pcn-k8s.yaml
+    kubectl delete -f |SCM_RAW_WEB|/src/components/k8s/pcn-k8s.yaml
 
 
 Testing pcn-k8s
@@ -250,7 +250,7 @@ In case you hit any problems, please follow the next steps to recover from a fai
 .. parsed-literal::
 
     #1. Remove pcn-k8s
-    kubectl delete -f |SCM_WEB|/src/components/k8s/pcn-k8s.yaml
+    kubectl delete -f |SCM_RAW_WEB|/src/components/k8s/pcn-k8s.yaml
 
     #2. Disable DNS
     kubectl -n kube-system scale --replicas=0 deployment/kube-dns
@@ -260,7 +260,7 @@ In case you hit any problems, please follow the next steps to recover from a fai
     ip link del dev pcn_vxlan
 
     #4. Relaunch pcn-k8s
-    kubectl apply -f |SCM_WEB|/src/components/k8s/pcn-k8s.yaml
+    kubectl apply -f |SCM_RAW_WEB|/src/components/k8s/pcn-k8s.yaml
 
     # Wait until all pcn-k8s containers are in running state
     kubectl get pods --all-namespaces

Documentation/components/k8s/pcn-kubernetes.rst

@@ -10,7 +10,7 @@ Deploy services and pods to test
 
 .. parsed-literal::
 
-    kubectl create -f |SCM_WEB|/src/components/k8s/examples/echoserver_nodeport.yaml
+    kubectl create -f |SCM_RAW_WEB|/src/components/k8s/examples/echoserver_nodeport.yaml
     kubectl run curl1 --image=tutum/curl --replicas=5 --command -- sleep 600000
 
 

Documentation/components/k8s/testing.rst

@@ -180,19 +180,23 @@
 
 
 # taken from cilium
-# TODO: how to actually get the branch
-branch = 'master'
-githubusercontent = 'https://raw.githubusercontent.com/polycube-network/polycube/'
-scm_web = githubusercontent + branch
+branch = os.environ.get('READTHEDOCS_VERSION')
+if branch == None or branch == 'latest':
+    branch = 'master'
+
+scm_raw_web = 'https://raw.githubusercontent.com/polycube-network/polycube/' + branch
+scm_web = 'https://github.com/polycube-network/polycube/blob/' + branch
 
 # Store variables in the epilogue so they are globally available.
 rst_epilog = """
 .. |SCM_WEB| replace:: \{s}
+.. |SCM_RAW_WEB| replace:: \{sr}
 .. |SCM_BRANCH| replace:: \{b}
-""".format(s = scm_web, b = branch)
+""".format(s = scm_web, sr = scm_raw_web, b = branch)
 
 # used to have links to repo files
-extlinks = {'scm_web_file': (scm_web + '/%s', 'scm_web_file ')}
+extlinks = {'scm_raw_web': (scm_raw_web + '/%s', 'scm_raw_web'),
+            'scm_web': (scm_web + '/%s', 'scm_web')}
 
 # spell configuration
 spelling_lang='en_US'