summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2024-11-21 15:57:12 +0100
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2024-11-21 16:06:22 +0100
commita587163c822e80527f6acc78c1edac3410327854 (patch)
tree15ddd4ee5e2f7af01eeef98fb4adc4bd6c651776 /docs/src
parent72edbfe5d2d51b7dbaaa6ac6fe96cfbd43b60069 (diff)
Replace all links from GitHub to Codeberg
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/about.md2
-rw-r--r--docs/src/api/codeexamples.md2
-rw-r--r--docs/src/api/letsbuildaclient.md2
-rw-r--r--docs/src/api/statemachine.md2
-rw-r--r--docs/src/api/wheretofinddocs.md4
-rw-r--r--docs/src/gettingstarted/building/example.md2
-rw-r--r--docs/src/gettingstarted/building/go.md2
-rw-r--r--docs/src/gettingstarted/building/release.md4
-rw-r--r--docs/src/gettingstarted/testing.md2
9 files changed, 11 insertions, 11 deletions
diff --git a/docs/src/about.md b/docs/src/about.md
index 08d7f9c..2066dde 100644
--- a/docs/src/about.md
+++ b/docs/src/about.md
@@ -18,7 +18,7 @@ The main goal is thus the following:
This library tries to remove non-platform specific common functionality. This way eduVPN clients have less duplicate code. The building blocks that are removed by the library is not just the four depicted in this figure. You can think of other building blocks, such as logging and local configuration file saving. As can be seen in the figure, no User Interface (UI) code will be implemented. This is left to the eduVPN clients, on top of platform-specific code.
## License
-[MIT](https://github.com/eduvpn/eduvpn-common/blob/main/LICENSE)
+[MIT](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/LICENSE)
## Authors
This library is written by [Steven Wallis de Vries](https://github.com/stevenwdv) and [Jeroen Wijenbergh](https://github.com/jwijenbergh) at the [SURF](https://www.surf.nl/) and [GÉANT](https://geant.org/) organization.
diff --git a/docs/src/api/codeexamples.md b/docs/src/api/codeexamples.md
index b3bcdc3..f47e99f 100644
--- a/docs/src/api/codeexamples.md
+++ b/docs/src/api/codeexamples.md
@@ -2,7 +2,7 @@
This chapter contains code examples that use the API
## Go command line client
-The following is an example [in the repository](https://github.com/eduvpn/eduvpn-common/blob/v2/cmd/cli/main.go). It is a command line client with the following flags
+The following is an example [in the repository](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/cmd/cli/main.go). It is a command line client with the following flags
```
-get-custom string
The url of a custom server to connect to
diff --git a/docs/src/api/letsbuildaclient.md b/docs/src/api/letsbuildaclient.md
index b675ee0..e513157 100644
--- a/docs/src/api/letsbuildaclient.md
+++ b/docs/src/api/letsbuildaclient.md
@@ -110,7 +110,7 @@ Note that this state transition is essentially the same as the following code:
```python
-def handler(old: int, new: int, data: str):
-- # it's 6 because https://github.com/eduvpn/eduvpn-common/blob/b660911b5db000b43970f3754b5767bb50741360/client/fsm.go#L33
+- # it's 6 because https://codeberg.org/eduVPN/eduvpn-common/src/commit/b660911b5db000b43970f3754b5767bb50741360/client/fsm.go#L33
- if new == 6:
- webbrowser.open(data)
- return True
diff --git a/docs/src/api/statemachine.md b/docs/src/api/statemachine.md
index 57ca775..953bf2b 100644
--- a/docs/src/api/statemachine.md
+++ b/docs/src/api/statemachine.md
@@ -90,7 +90,7 @@ The current state is highlighted in the <span style="color:cyan">cyan</span> col
## State explanation
-For the explanation of what all the different states mean, see the [client documentation](https://github.com/eduvpn/eduvpn-common/blob/v2/client/fsm.go#L14-L50)
+For the explanation of what all the different states mean, see the [client documentation](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/client/fsm.go#L14-L50)
## States that ask data
diff --git a/docs/src/api/wheretofinddocs.md b/docs/src/api/wheretofinddocs.md
index f4ad5bf..cda485f 100644
--- a/docs/src/api/wheretofinddocs.md
+++ b/docs/src/api/wheretofinddocs.md
@@ -1,6 +1,6 @@
# Where to find API docs
-The API documentation, depends on which wrapper you are using. If you're writing a wrapper yourself, or want some background information on how it works internally, you can find function docs in the [exports/exports.go](https://github.com/eduvpn/eduvpn-common/blob/v2/exports/exports.go) file it is available as autogenerated form [here](./functiondocs.md).
+The API documentation, depends on which wrapper you are using. If you're writing a wrapper yourself, or want some background information on how it works internally, you can find function docs in the [exports/exports.go](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/exports/exports.go) file it is available as autogenerated form [here](./functiondocs.md).
This file is commented using Go comment style. It gives a basic of what the function does, what it returns and what type of arguments you should pass to it. The API documentation for the Python wrapper can be [found here](https://eduvpn.github.io/eduvpn-common/api/python/rtd/index.html).
-There is also a Go API that is defined in the [client package](https://github.com/eduvpn/eduvpn-common/tree/v2/client). However, this is not the primary use case for the library.
+There is also a Go API that is defined in the [client package](https://codeberg.org/eduVPN/eduvpn-common/src/branch/main/client). However, this is not the primary use case for the library.
diff --git a/docs/src/gettingstarted/building/example.md b/docs/src/gettingstarted/building/example.md
index 902b419..58b1302 100644
--- a/docs/src/gettingstarted/building/example.md
+++ b/docs/src/gettingstarted/building/example.md
@@ -3,7 +3,7 @@ This section gives an example on how to build and install the library from scrat
1. Clone the library
```bash
-git clone https://github.com/eduvpn/eduvpn-common
+git clone https://codeberg.org/eduVPN/eduvpn-common
```
2. Go to the library directory
diff --git a/docs/src/gettingstarted/building/go.md b/docs/src/gettingstarted/building/go.md
index 65d3c26..c120c0a 100644
--- a/docs/src/gettingstarted/building/go.md
+++ b/docs/src/gettingstarted/building/go.md
@@ -29,7 +29,7 @@ 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://github.com/eduvpn/eduvpn-common/blob/main/make_release.sh) script on how we bundle the files. A full command without the Makefile to build this library is:
+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/release.md b/docs/src/gettingstarted/building/release.md
index a0893ea..5c5e4e1 100644
--- a/docs/src/gettingstarted/building/release.md
+++ b/docs/src/gettingstarted/building/release.md
@@ -1,8 +1,8 @@
# Building for release
-To build for release, make sure you obtain the tarball artifacts in the release (ending with `.tar.xz`) at <https://github.com/eduvpn/eduvpn-common/releases>.
+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://github.com/eduvpn/eduvpn-common/tree/main/keys>, they are also available externally:
+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>
diff --git a/docs/src/gettingstarted/testing.md b/docs/src/gettingstarted/testing.md
index b072849..a3ed87d 100644
--- a/docs/src/gettingstarted/testing.md
+++ b/docs/src/gettingstarted/testing.md
@@ -13,7 +13,7 @@ Note that this runs the tests without any server interaction (so for now only th
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://github.com/eduvpn/eduvpn-common/blob/main/selenium_eduvpn.py).
+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