Add logo; Hide unfinished page; Clarified intro page; Add guide index page

Author: korridor

docs/self-hosting/configuration.md

@@ -13,7 +13,7 @@ The configuration contains placeholders (`your-domain.com`, `your-bucket-name`,
 
 The configuration example below is for a production environment using HTTPS. You can adjust the values to your needs, in any case you will have to change `APP_URL` to the URL of your solidtime instance.
 
-```dotenv
+```bash
 APP_ENV="production"
 APP_DEBUG="false"
 APP_URL="https://your-domain.com"
@@ -31,7 +31,7 @@ TRUSTED_PROXIES="0.0.0.0/0,2000:0:0:0:0:0:0:0/3"
 
 You can run `docker run --rm solidtime/solidtime:main php artisan self-host:generate-keys` to obtain `APP_KEY`, `PASSPORT_PRIVATE_KEY` and `PASSPORT_PUBLIC_KEY`
 
-```dotenv
+```bash
 APP_KEY=""
 PASSPORT_PRIVATE_KEY=""
 PASSPORT_PUBLIC_KEY=""
@@ -51,21 +51,21 @@ You can read more about the logging configuration in the [Laravel documentation]
 
 **Store logs in files under storage/logs with one log file per day:**
 
-```dotenv
+```bash
 LOG_CHANNEL="daily"
 LOG_LEVEL="debug"
 ```
 
 **Output logs via stderr:**
 
-```dotenv
+```bash
 LOG_CHANNEL="stderr"
 LOG_LEVEL="debug"
 ```
 
 **Output logs via stderr and store the in daily log files:**
 
-```dotenv
+```bash
 LOG_CHANNEL="stderr_daily"
 LOG_LEVEL="debug"
 ```
@@ -75,7 +75,7 @@ LOG_LEVEL="debug"
 You can read more about the database configuration in the [Laravel documentation](https://laravel.com/docs/11.x/database#configuration).
 Please remember that solidtime only supports PostgreSQL.
 
-```dotenv
+```bash
 DB_HOST="your-database-host-or-ip"
 DB_PORT="5432"
 DB_SSLMODE="require"
@@ -90,7 +90,7 @@ Configure the email settings for sending emails. Solidtime supports every (trans
 
 ### Example using Scaleway TEM via SMTP
 
-```dotenv
+```bash
 MAIL_MAILER="smtp"
 MAIL_HOST="smtp.tem.scw.cloud"
 MAIL_PORT="465"
@@ -107,7 +107,7 @@ If you want to test f.e. the registration before setting up a transactional emai
 This logs outgoing emails to the log file.
 If you want to copy the link for the email verification, use the one from the textual, non-HTML version of the email in the log file.
 
-```dotenv
+```bash
 MAIL_MAILER="log"
 ```
 
@@ -119,15 +119,15 @@ You can read more about the queue configuration in the [Laravel documentation](h
 
 You can use this option if you don't want to use a separate Queue Worker (f.e. a `worker` container, see [Container Mode](./container-mode.md)) that handles queued jobs asynchronously. It will dispatch jobs synchronously. **We do not recommend using this option in production.** 
 
-```dotenv
+```bash
 QUEUE_CONNECTION="sync"
 ```
 
 ### Database
 
 Please keep in mind that you need a separate Queue Worker (f.e. a `worker` container, see [Container Mode](./container-mode.md)) that handles queued jobs asynchronously to use this configuration option.
 
-```dotenv
+```bash
 QUEUE_CONNECTION="database"
 ```
 
@@ -143,14 +143,14 @@ You can read more about the file storage configuration in the [Laravel documenta
 
 ### Local Disk
 
-```dotenv
+```bash
 FILESYSTEM_DISK="local"
 PUBLIC_FILESYSTEM_DISK="public"
 ```
 
 ### Scaleway Object Storage
 
-```dotenv
+```bash
 FILESYSTEM_DISK="s3"
 PUBLIC_FILESYSTEM_DISK="s3"
 S3_REGION="fr-par" # fr-par, nl-ams, pl-waw

docs/self-hosting/container-mode.md

@@ -10,18 +10,24 @@ The mode can be defined by setting the `CONTAINER_MODE` environment variable on
 
 ## HTTP Server
 
-`CONTAINER_MODE=http`
+```bash
+CONTAINER_MODE=http
+```
 
 The HTTP server mode is the default mode. It starts the HTTP server for the solidtime application. The solidtime image uses Swoole as an HTTP server.
 
 ## Scheduler
 
-`CONTAINER_MODE=scheduler`
+```bash
+CONTAINER_MODE=scheduler
+```
 
 The scheduler mode starts the Laravel scheduler. The scheduler is used to run scheduled tasks like sending reminders, similar to running cronjobs.
 
 ## Worker
 
-`CONTAINER_MODE=worker`
+```bash
+CONTAINER_MODE=worker
+```
 
 The worker mode starts the Laravel Queue Worker. It is used to process asynchronous tasks like sending emails, when `QUEUE_CONNECTION` is set to `database`.

docs/self-hosting/guides/docker.md

@@ -4,6 +4,7 @@ sidebar_position: 1
 # Docker
 
 This guide will help you to deploy solidtime using Docker and Docker Compose.
+It uses our official Docker images that are available on [Docker Hub](https://hub.docker.com/r/solidtime/solidtime).
 We have a repository with some example configurations for Docker Compose. You can find it [here](https://github.com/solidtime-io/self-hosting-examples).
 The guide will reference this repository.
 

docs/self-hosting/guides/index.mdx

@@ -0,0 +1,5 @@
+# Guides
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />

docs/self-hosting/guides/kubernetes-helm.md

@@ -1,5 +1,6 @@
 ---
 sidebar_position: 2
+draft: true
 ---
 # Kubernetes + Helm
 

docs/self-hosting/intro.md

@@ -9,9 +9,11 @@ This guide is for users who want to learn how to self-host solidtime.
 
 If you have problems with the self-hosting guide, please open an issue on [GitHub](https://github.com/solidtime-io/solidtime/issues) or join our [Discord server](https://discord.gg/Wd7pNH5S64).
 
-## Docker image
+## Getting Started
 
-We provide a Docker image for solidtime. You can find the Docker image on [Docker Hub](https://hub.docker.com/r/solidtime/solidtime).
+We currently provide a detailed guide on how to deploy solidtime using Docker/Docker Compose.
+
+You can find the guide [here](/self-hosting/guides/docker).
 
 ## FAQ
 

docs/self-hosting/super-admin-panel.md

@@ -16,7 +16,7 @@ The super admin panel is made for technical users that are responsible for the s
 
 To access the super admin panel, you need to be a super admin. The super admins are defined in the `.env` file of the self-hosted solidtime instance.
 
-```dotenv
+```bash
 SUPER_ADMINS="[email protected],[email protected]"
 ```
 

docusaurus.config.ts

@@ -34,6 +34,7 @@ const config: Config = {
                         from: '/self-hosting/environments/docker',
                         to: '/self-hosting/guides/docker',
                     },
+                    /*
                     {
                         from: '/self-hosting/kubernetes-helm',
                         to: '/self-hosting/guides/kubernetes-helm',
@@ -42,6 +43,7 @@ const config: Config = {
                         from: '/self-hosting/environments/kubernetes-helm',
                         to: '/self-hosting/guides/kubernetes-helm',
                     },
+                    */
                 ],
             }
         ]
@@ -87,7 +89,11 @@ const config: Config = {
     themeConfig: {
         image: 'img/og_image.png',
         navbar: {
-            title: 'solidtime',
+            logo: {
+                alt: 'Site Logo',
+                src: 'img/solidtime-logo.svg',
+                srcDark: 'img/solidtime-logo-dark-mode.svg',
+            },
             items: [
                 {
                     type: 'doc',
@@ -97,7 +103,7 @@ const config: Config = {
                 },
                 {
                     type: 'doc',
-                    docId: 'self-hosting/intro',
+                    docId: 'self-hosting/index',
                     position: 'left',
                     label: 'Self-hosting',
                 },
@@ -131,6 +137,7 @@ const config: Config = {
         prism: {
             theme: prismThemes.github,
             darkTheme: prismThemes.dracula,
+            additionalLanguages: ['bash'],
         },
     } satisfies Preset.ThemeConfig,
 };