Skip to content

Commit b84e3b2

Browse files
authored
Updated links of documentation to readthedocs (polycube-network#208)
Signed-off-by: Fulvio Risso <[email protected]>
1 parent 38f2fb4 commit b84e3b2

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

Documentation/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Polycube Documentation
22

3-
*The polycube documentation is not designed to be read on github, so please see our website: TODO: put link here*
3+
**The polycube documentation is available on [ReadTheDocs](https://polycube-network.readthedocs.io/en/latest/).**
44

5-
## Building the documentation
5+
The instructions below are intended if you want to generate the documentation locally.
6+
7+
## Building the documentation locally
68

79
### Installing the dependencies
810

Documentation/intro.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ Outstanding performance with real applications
6363
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6464
Two standalone applications have been released to show the potential of Polycube, ``pcn-iptables`` and ``pcn-k8s``.
6565

66-
- `pcn-iptables`: The former is a clone of **iptables** that is able to filter packets passing through a Linux host, demonstrating how packet filtering can be achieved with impressive performance, while at the same time guaranteeing the same command line and the same external behavior of the original software.
67-
- `pcn-k8s`: The latter is a network plug-in for **Kubernetes**, i.e., a software that handles the entire virtual network of a Kubernetes cluster, which includes bridging, routing, NAT, load balancing and tunneling services. Our plug-in has been tested for scalability and guarantees outstanding performance in terms of network throughput.
66+
- `pcn-iptables`: is a clone of **iptables** that is able to filter packets passing through a Linux host, demonstrating how packet filtering can be achieved with impressive performance, while at the same time guaranteeing the same command line and the same external behavior of the original software.
67+
- `pcn-k8s`: is a CNI network plugin for **Kubernetes**, i.e., a software that handles the entire virtual network of a Kubernetes cluster, which includes bridging, routing, NAT, load balancing and tunneling services. Our plug-in has been tested for scalability and guarantees outstanding performance in terms of network throughput.
6868

6969

7070
Powered by eBPF and XDP

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010

1111
Polycube services, called `cubes`, can be composed to build arbitrary **service chains** and provide custom network connectivity to **namespaces**, **containers**, **virtual machines**, and **physical hosts**.
1212

13-
For more information, jump to the [Documentation](Documentation) section.
13+
For more information, jump to the project [Documentation](https://polycube-network.readthedocs.io/en/latest/).
1414

1515

1616
## Quick links
17-
- [What is Polycube?](Documentation/intro.rst)
18-
- [Quickstart](Documentation/quickstart.rst)
19-
- [Documentation](Documentation)
20-
- [pcn-k8s - Kubernetes network provider](Documentation/components/k8s/pcn-kubernetes.rst)
21-
- [pcn-iptables - Iptables clone](Documentation/components/iptables/pcn-iptables.rst)
17+
- [Introduction to Polycube](https://polycube-network.readthedocs.io/en/latest/intro.html)
18+
- [Quickstart](https://polycube-network.readthedocs.io/en/latest/quickstart.html)
19+
- [Documentation](https://polycube-network.readthedocs.io/en/latest/)
20+
- [pcn-k8s - The CNI network plugin for Kubernetes](https://polycube-network.readthedocs.io/en/latest/components/k8s/pcn-kubernetes.html)
21+
- [pcn-iptables - A clone of Iptables based on eBPF](https://polycube-network.readthedocs.io/en/latest/components/iptables/pcn-iptables.html)
2222

2323

2424
## Licence

0 commit comments

Comments
 (0)