Tryout of documentation

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: Generate MkDocs and upload
+
+on:
+  push:
+    branches:
+      - docs
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.10
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install mkdocs
+        sudo apt-get update
+        sudo apt-get install -y lftp
+
+    - name: Build MkDocs site
+      run: |
+        mkdocs build
+    - name: Upload HTML files to FTP server
+      env:
+        FTP_SERVER: ${{ secrets.FTP_SERVER }}
+        FTP_USERNAME: ${{ secrets.FTP_USERNAME }}
+        FTP_PASSWORD: ${{ secrets.FTP_PASSWORD }}
+      run: |
+        lftp -e "mirror -R site/ /home/godesig/www/docs.hashtopolis.org/; quit" -u $FTP_USERNAME,$FTP_PASSWORD $FTP_SERVER

.gitignore

@@ -25,3 +25,5 @@ vendor
 # For python cache files
 __pycache__
 .pytest_cache
+
+site/

doc/install.md

@@ -0,0 +1,14 @@
+# Installation Guidelines
+## Basic installation
+### Server installation
+
+_NOTE: The instructions provided in this section have only been tested on Ubuntu 22.04 and Windows 11 with WSL2_
+
+To install Hashtopolis server, ensure that the following prerequisites are met:
+1. *Docker*: Follow the instructions available on the Docker website:
+   - Install Docker on Ubuntu
+   - Install Docker on Windows
+2. *Docker Compose v2*: Follow the instructions available on the Docker website:
+   - [Install Docker Compose on Linux](https://docs.docker.com/compose/install/linux/#install-using-the-repository)
+
+

mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: Hashtopolis
+site_url: https://docs.hashtopolis.org
+repo_url: https://github.com/hashtopolis/server
+docs_dir: doc
+theme:
+  name: readthedocs
+nav:
+  - 'install.md'