Docs: Move to Mkdocs & Codeberg pages

8 files changed, 0 insertions, 150 deletions

diff --git a/docs/src/gettingstarted/README.md b/docs/src/gettingstarted/README.md
deleted file mode 100644
index 252c8b1..0000000
--- a/docs/src/gettingstarted/README.md
+++ /dev/null
@@ -1,6 +0,0 @@
-# Getting started
-This chapter contains the steps to get started with the Go library and the Python wrapper. You will learn how to build the library/wrapper, how to run the test suite and how to debug possible errors.
-
-Note that the Python wrapper is currently the only wrapper. So for now, we only document the Python wrapper in this documentation and in the future document the other wrappers as well.
-
-The documentation on how to use this library in your own code will be given in the next chapter: [API](../api/index.html).
diff --git a/docs/src/gettingstarted/building/README.md b/docs/src/gettingstarted/building/README.md
deleted file mode 100644
index 00295bf..0000000
--- a/docs/src/gettingstarted/building/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# Building
-This section contains the instruction on how to build the library and associated wrappers. We first explain how to build the Go library and then further explain the wrapper specific building process. As the Python wrapper is the only wrapper at the moment, this only consists of this wrapper language for now.
diff --git a/docs/src/gettingstarted/building/example.md b/docs/src/gettingstarted/building/example.md
deleted file mode 100644
index 58b1302..0000000
--- a/docs/src/gettingstarted/building/example.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# Example: commands to build for Python
-This section gives an example on how to build and install the library from scratch (assuming you have all the dependencies). It builds the Go library and then builds and installs the Python wrapper.
-
-1. Clone the library
-```bash
-git clone https://codeberg.org/eduVPN/eduvpn-common
-```
-
-2. Go to the library directory
-```bash
-cd eduvpn-common
-```
-
-3. Build the go library
-```bash
-make
-```
-
-4. Build the python wrapper
-```bash
-make -C wrappers/python
-```
-
-5. Install the wheel using pip
-```bash
-# x.x.x is the version here
-pip install wrappers/python/dist/eduvpncommon-x.x.x-py3-none-linux_x86_64.whl
-```
-Note that the name of your wheel changes on the platform and version.
diff --git a/docs/src/gettingstarted/building/go.md b/docs/src/gettingstarted/building/go.md
deleted file mode 100644
index c120c0a..0000000
--- a/docs/src/gettingstarted/building/go.md
+++ /dev/null
@@ -1,36 +0,0 @@
-# Building the Go library
-To build the Go library, you need the dependencies for your system installed. We will go over the needed dependencies for Linux. Afterwards, we explain the basic commands to build the library.
-
-## Dependencies
-### Linux
-To build the Go shared library using Linux you need the following dependencies:
-
-- [Go](https://go.dev/doc/install) 1.18 or later
-- [Gcc](https://gcc.gnu.org/)
-- [GNU Make](https://www.gnu.org/software/make/)
-- Dependencies for the Python wrapper if you want to build that as well
-
-## Commands
-Before we can begin building the wrapper code, we need to build the Go code as a shared library. This section will tell you how to do so.
-
-To build the shared library for the current platform issue the following command in the root directory:
-
-```bash
-make
-```
-
-The shared library will be output in `lib/`.
-
-### Cleaning
-To clean build the library and wrapper, issue the following command in the root directory:
-
-```bash
-make clean
-```
-
-## Note on releases
-Releases are build with the go tag "release" (add flag "-tags=release") to bundle the discovery JSON files and embed them in the shared library. See the [make_release](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/make_release.sh) script on how we bundle the files. A full command without the Makefile to build this library is:
-
-```bash
-go build -o lib/libeduvpn_common-${VERSION}.so -tags=release -buildmode=c-shared ./exports
-```
diff --git a/docs/src/gettingstarted/building/packageformats.md b/docs/src/gettingstarted/building/packageformats.md
deleted file mode 100644
index 37f5061..0000000
--- a/docs/src/gettingstarted/building/packageformats.md
+++ /dev/null
@@ -1,9 +0,0 @@
-# Package formats
-
-We support the following additional package formats: RPM (Linux, Fedora) and Deb (Linux, Debian derivatives)
-
-# Linux: RPM
-The RPM files can be found on a [SourceHut Repo](https://git.sr.ht/~jwijenbergh/python3-eduvpn-common.rpm).These are then build with [builder.rpm](https://codeberg.org/eduVPN/builder.rpm).
-
-# Linux: Deb
-The RPM files can be found on a [SourceHut Repo](https://git.sr.ht/~jwijenbergh/python3-eduvpn-common.deb). These are then build with [nbuilder.deb](https://codeberg.org/eduVPN/nbuilder.deb).
diff --git a/docs/src/gettingstarted/building/python.md b/docs/src/gettingstarted/building/python.md
deleted file mode 100644
index 03e064a..0000000
--- a/docs/src/gettingstarted/building/python.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Python wrapper
-
-To build the python wrapper issue the following command (in the root directory of the eduvpn-common project):
-
-```bash
-make -C wrappers/python
-```
-
-This uses the makefile in `wrappers/python/Makefile` to build the python file into a wheel placed in `wrappers/python/dist/eduvpncommon-[version]-py3-none-[platform].whl`. Where version is the version of the library and platform is your current platform. 
-
-The wheel can be installed with `pip`:
-
-```bash
-pip install ./wrappers/python/dist/eduvpncommon-[version]-py3-none-[platform].whl
-```
diff --git a/docs/src/gettingstarted/building/release.md b/docs/src/gettingstarted/building/release.md
deleted file mode 100644
index 5c5e4e1..0000000
--- a/docs/src/gettingstarted/building/release.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Building for release
-
-To build for release, make sure you obtain the tarball artifacts in the release (ending with `.tar.xz`) at <https://codeberg.org/eduVPN/eduvpn-common/releases>.
-
-These are signed with minisign and gpg keys, make sure to verify these signatures using the public keys available here: <https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/keys>, they are also available externally:
-- <https://app.eduvpn.org/linux/v4/deb/app+linux@eduvpn.org.asc>
-- <https://git.sr.ht/~jwijenbergh/python3-eduvpn-common.rpm/tree/main/item/SOURCES/minisign-CA9409316AC93C07.pub>
-
-To build for release, make sure to extract the tarball, and then add `-tags=release` to the `GOFLAGS` environment variable:
-
-```bash
-GOFLAGS="-tags=release" make
-```
-
-Proceed the build like normally.
diff --git a/docs/src/gettingstarted/testing.md b/docs/src/gettingstarted/testing.md
deleted file mode 100644
index a3ed87d..0000000
--- a/docs/src/gettingstarted/testing.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Testing
-The Go library right now has various tests defined. E.g. server interaction, oauth, discovery and signature verification tests.
-
-To run the Go test suite, issue the following command in a shell
-
-```bash
-make test
-```
-
-Note that this runs the tests without any server interaction (so for now only the signature verification tests). To run the tests with an eduVPN server you need to specify environment variables:
-
-```bash
-SERVER_URI="eduvpn.example.com" PORTAL_USER="example" PORTAL_PASS="example" make test
-```
-
-This needs [python3-selenium](https://selenium-python.readthedocs.io/) and [geckodriver](https://github.com/mozilla/geckodriver/releases) (extract and put in your `$PATH`). Note that testing with a server assumes it uses a default portal, due to it needing to click on buttons on the web page. You can add your own portal by customizing the [called Selenium script](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/selenium_eduvpn.py).
-
-If you have [Docker](https://www.docker.com/get-started/) installed and [Docker-compose](https://docs.docker.com/compose/install/) you can use a convenient helper script which starts up two containers
-- An eduVPN server for testing
-- A Go container that builds and runs the test-suite
-
-```bash
-PORTAL_USER="example" PORTAL_PASS="example" ./ci/startcompose.sh
-```
-Note that this helper script also assumes you have the [OpenSSL](https://www.openssl.org/) command line tool installed. This is used to install the self-signed certificates for testing.
-
-This script is also used in the continuous integration, so we recommend to run this before you submit any changes.
-
-There are other environment variables that can be used:
-
-- `OAUTH_EXPIRED_TTL`: Use this for a server which has a low OAuth access token expiry time, e.g. 10 seconds. You would then set this variable to `"10"` so that a test is ran which waits for 10 seconds for the OAuth tokens to expire
-- `EDUVPN_PODCOMP`: Set this to 1 to instruct the `./ci/startcompose.sh` script to use [podman-compose](https://github.com/containers/podman-compose) if you prefer this over using docker-compose.
-## Testing the Python code
-To test the Python code, issue the following command in a shell (you will need dependencies for all wrappers if you do this[^1]):
-
-```bash
-make -C wrappers/python test
-```