Merge pull request #640 from crowdsecurity/warning_maintenance

Maintenance
crowdsecurity · Oct 30, 2024 · 44babca · 44babca
2 parents 92d4385 + 2b66404
commit 44babca
Show file tree

Hide file tree

Showing 13 changed files with 16,301 additions and 25,487 deletions.
diff --git a/README.md b/README.md
@@ -2,4 +2,29 @@
 
 This repository holds the documentation for the [crowdsec project](https://github.com/crowdsecurity/crowdsec).
 
-Online version of this documentation is available here: https://doc.crowdsec.net/
+Online version of this documentation is available here: https://doc.crowdsec.net/
+
+The documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```console
+npm install
+```
+
+## Local Development
+
+```console
+npm run start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```console
+npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+you can also use the `npm run serve` command to test the build locally.
diff --git a/crowdsec-docs/README.md b/crowdsec-docs/README.md
diff --git a/crowdsec-docs/blog/2020-08-04-crowdsec_firewall_freebsd.md b/crowdsec-docs/blog/2020-08-04-crowdsec_firewall_freebsd.md
@@ -1,8 +1,7 @@
 ---
 slug: crowdsec_firewall_freebsd
 title: How to install CrowdSec Firewall Bouncer on FreeBSD
-author: Sofian Brabez
-author_url: https://github.com/sbz
+authors: [sbz]
 tags: [bouncer, firewall, crowdsec]
 ---
 

diff --git a/crowdsec-docs/blog/2021-08-30-metabase_without_docker.md b/crowdsec-docs/blog/2021-08-30-metabase_without_docker.md
@@ -1,8 +1,7 @@
 ---
 slug: metabase_without_docker
 title: How to configure metabase dasbhoard without docker
-author: Crowdsec Team
-author_url: https://github.com/crowdsecurity
+authors: crowdsec
 tags: [dashboard, metabase]
 ---
 

diff --git a/crowdsec-docs/blog/2024-06-11-cscli_dashboard_deprecation.md b/crowdsec-docs/blog/2024-06-11-cscli_dashboard_deprecation.md
@@ -1,8 +1,7 @@
 ---
 slug: cscli_dashboard_deprecation
 title: Cscli dashboard deprecation
-author: Crowdsec Team
-author_url: https://github.com/crowdsecurity
+authors: crowdsec
 tags: [dashboard, Metabase]
 ---
 

diff --git a/crowdsec-docs/blog/authors.yml b/crowdsec-docs/blog/authors.yml
@@ -0,0 +1,8 @@
+sbz:
+    name: Sofian Brabez
+    url: https://github.com/sbz
+
+crowdsec:
+    name: Crowdsec Team
+    url: https://github.com/crowdsecurity
+    image_url: /img/crowdsec_logo.png
diff --git a/crowdsec-docs/docusaurus.config.js b/crowdsec-docs/docusaurus.config.js
@@ -5,6 +5,7 @@ const {
     ctiApiSidebar,
     guidesSideBar,
 } = require("./sidebarsUnversioned.js")
+const tailwindConfig = require("./tailwind.config.js")
 
 const generateCurrentAndNextRedirects = (s) => [
     {
@@ -312,16 +313,6 @@ module.exports = {
                 ],
             },
         ],
-        async function myPlugin(context, options) {
-            return {
-                name: "docusaurus-tailwindcss",
-                configurePostCss(postcssOptions) {
-                    // Appends TailwindCSS and AutoPrefixer.
-                    postcssOptions.plugins.push(require("tailwindcss"))
-                    postcssOptions.plugins.push(require("autoprefixer"))
-                    return postcssOptions
-                },
-            }
-        },
+        "./plugins/tailwind-config.js",
     ],
 }