docs: switch to github pages and add warning

depado · Dec 10, 2024 · f62f4e8 · f62f4e8
1 parent 0c90e47
commit f62f4e8
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -6,11 +6,13 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/Depado/goploader)](https://goreportcard.com/report/github.com/Depado/goploader)
 [![codebeat badge](https://codebeat.co/badges/0faefc03-91a4-41e7-a955-ccd8c1b096cd)](https://codebeat.co/projects/github-com-depado-goploader)
 [![Maintainability](https://api.codeclimate.com/v1/badges/af3e40751fb9d01d4627/maintainability)](https://codeclimate.com/github/Depado/goploader/maintainability)
-[![Build Status](https://drone.depado.eu/api/badges/Depado/goploader/status.svg)](https://drone.depado.eu/Depado/goploader)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Depado/goploader/blob/master/LICENSE)
-[![Docs](https://img.shields.io/badge/docs-gpldr.in-blue.svg)](https://docs.gpldr.in/)
 [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/Depado)
 
+> [!WARNING]  
+> This repository is maintained as is but most of the tech used for this project
+> is now outdated. Use at your own risk. 
+
 ## Introduction
 
 Goploader's ultimate goal is to make file sharing easy and painless. This project is composed of a server and a client, both written in Go. The main things to remember about the project are :

diff --git a/docs/docs/client/build.md b/docs/docs/client/build.md
@@ -1,6 +1,6 @@
 If you don't want to download a pre-compiled version of goploader client you can
 build it from source. Otherwise you can directly download a pre-compiled binary
-[here](/client/install.md).
+[here](install.md).
 
 ## Prerequisites
 
@@ -31,4 +31,4 @@ $ go build -i -o gpldr github.com/Depado/goploader/client
 
 Ensure you have `$GOPATH/bin` added to your standard `$PATH` so you can have
 access to the binary you just built. Then head over to 
-[the client's documentation](/client/documentation.md) to learn how to use it.
+[the client's documentation](documentation.md) to learn how to use it.
diff --git a/docs/docs/server/build.md b/docs/docs/server/build.md
@@ -1,6 +1,7 @@
+# Building from source
+
 If you don't want to download a pre-compiled version of goploader server you can
-build it from source. Otherwise you can directly download a pre-compiled binary
-[here](/server/downloads.md).
+build it from source.
 
 ## Prerequisites
 
@@ -26,7 +27,7 @@ Now all you have to do is build the project :
 $ go build -o server github.com/Depado/goploader/server
 ```
 
-That's it. Now head to the [setup](/server/install.md) part to see how to
+That's it. Now head to the [setup](install.md) part to see how to
 generate or create the `conf.yml` file that is necessary for goploader to run.
 
 !!! tip "Embedding resources in the binary"
@@ -47,4 +48,4 @@ generate or create the `conf.yml` file that is necessary for goploader to run.
     ```
 
     This step must be executed before building the binary if you want embedded
-    assets.
+    assets.
diff --git a/docs/docs/server/downloads.md b/docs/docs/server/downloads.md
@@ -1,36 +1,19 @@
-<style>
-    .btn{
-        border-radius: 4px; 
-        padding: 10px 32px; 
-        text-align: center; 
-        text-decoration: none; 
-        background-color: white;
-        color: black;
-        margin: 5px;
-        border: 1px solid #3f51b5;
-        display: inline-block;
-    }
-</style>
+# Downloads
+
+All downloads can be found on the 
+[releases](https://github.com/depado/goploader/releases) page on GitHub. This
+page exists to explain the different download types.
 
 ## Standalone Downloads
 
 The standalone distribution contains only a binary. All assets and templates 
 (html files, css, js, etc) are included directly in the binary. If you don't 
 intend to modify those assets, this distribution is for you. All you have to
-do is download the archive, and go the [Setup](/server/install.md) page to read
+do is download the archive, and go the [Setup](install.md) page to read
 the instructions on how to setup goploader server.
 
-<div style="text-align: center;">
-    <a class="btn" href="https://gpldr.in/releases/servers/server-standalone_amd64.tar.gz">Linux 64-bit Standalone</a>
-    <a class="btn" href="https://gpldr.in/releases/servers/server-standalone_arm.tar.gz">Linux ARMv7 Standalone</a>
-</div>
-
 ## Simple Downloads
 
 These downloads contain the pre-compiled binary along with all its assets.
 You're free to modify what you want in those assets. (HTML templates, CSS, JS)
 
-<div style="text-align: center;">
-    <a class="btn" href="https://gpldr.in/releases/servers/server_amd64.tar.gz">Linux 64-bit</a>
-    <a class="btn" href="https://gpldr.in/releases/servers/server_arm.tar.gz">Linux ARMv7</a>
-</div>
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,30 +1,29 @@
-certifi==2024.7.4
-charset-normalizer==2.0.12
-click==8.1.3
-colorclass==2.2.2
-docopt==0.6.2
+babel==2.16.0
+certifi==2024.8.30
+charset-normalizer==3.4.0
+click==8.1.7
+colorama==0.4.6
 ghp-import==2.1.0
-idna==3.7
-importlib-metadata==4.11.3
+idna==3.10
 Jinja2==3.1.4
-livereload==2.6.3
-Markdown==3.3.7
-MarkupSafe==2.1.1
+Markdown==3.7
+MarkupSafe==3.0.2
 mergedeep==1.3.4
-mkdocs==1.3.0
-mkdocs-material==8.2.14
-mkdocs-material-extensions==1.0.3
-packaging==21.3
-Pygments==2.15.0
-pymdown-extensions==10.0
-pyparsing==3.0.9
-python-dateutil==2.8.2
-PyYAML==6.0
+mkdocs==1.6.1
+mkdocs-get-deps==0.2.0
+mkdocs-material==9.5.48
+mkdocs-material-extensions==1.3.1
+packaging==24.2
+paginate==0.5.7
+pathspec==0.12.1
+platformdirs==4.3.6
+Pygments==2.18.0
+pymdown-extensions==10.12
+python-dateutil==2.9.0.post0
+PyYAML==6.0.2
 pyyaml_env_tag==0.1
-requests==2.32.0
-six==1.16.0
-terminaltables==3.1.10
-tornado==6.4.2
-urllib3==1.26.19
-watchdog==2.1.7
-zipp==3.19.1
+regex==2024.11.6
+requests==2.32.3
+six==1.17.0
+urllib3==2.2.3
+watchdog==6.0.0