Merge pull request #251 from kimatata/develop

.github/workflows/deploy-docs.yml

@@ -0,0 +1,49 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+        working-directory: docs
+      - name: Build website
+        run: npm run build
+        working-directory: docs
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/docs/usage/backup.md

@@ -6,12 +6,18 @@ sidebar_position: 2
 
 ## Database backup
 
-UnitTCMS uses SQLite for data persistence. Therefore, backing up the DB is simply backing up the SQLite DB file.
+UnitTCMS uses SQLite for data persistence. Therefore, backing up the database is simply backing up the SQLite DB file.
 
-Please backup the file `backend/database/database.sqlite`
+Please back up the file `backend/database/database.sqlite`.
+
+:::note[In Docker environment]
+
+In a docker environment, DB file is stored in a Docker named volume (`db-data`).
+
+:::
 
 ## Backup of uploaded files
 
-Uploaded files are managed separately from the DB. If you have uploaded files, you need to backup them too.
+Uploaded files are managed separately from the database. If you have uploaded files, you need to back them up too.
 
-Please backup the files under `backend/public/uploads` directory.
+Please back up the files under the `backend/public/uploads` directory.