Upgrade to Docusaurus 3

distribworks · Dec 11, 2023 · 0d9abcd · 0d9abcd
1 parent 1d1bbe8
commit 0d9abcd
Show file tree

Hide file tree

Showing 24 changed files with 19,218 additions and 9,773 deletions.
diff --git a/website/.yarn/install-state.gz b/website/.yarn/install-state.gz
diff --git a/website/docs/pro/acls.md b/website/docs/pro/acls.md
@@ -16,9 +16,9 @@ The ACL system is designed to be easy to use and fast to enforce while providing
 
 * **ACL Policies.** Dkron's ACL policies are simple JSON documents that define patterns to allow access to resources. You can find below an example ACL policy that works with the default OPA policy. The ACL JSON structure is not rigid you can adapt it to add new features in combination with the OPA Policy rules.
 
-{{% notice note %}}
+:::info
 This guide is based on the usage of the default OPA Rego Policy
-{{% /notice %}}
+:::
 
 ## Configuring ACLs
 

diff --git a/website/docs/usage/cron-spec.md b/website/docs/usage/cron-spec.md
@@ -70,10 +70,11 @@ You may use one of several pre-defined schedules in place of a cron expression.
 You may also schedule a job to execute at fixed intervals.  This is supported by
 formatting the cron spec like this:
 
-    @every <duration>
+```
+	@every <duration>
+```
 
-where "duration" is a string accepted by time.ParseDuration
-(<http://golang.org/pkg/time/#ParseDuration>).
+where "duration" is a string accepted by time.ParseDuration http://golang.org/pkg/time/#ParseDuration.
 
 For example, "@every 1h30m10s" would indicate a schedule that activates every
 1 hour, 30 minutes, 10 seconds.
@@ -87,10 +88,11 @@ it will have only 2 minutes of idle time between each run.
 You may also want to schedule a job to be executed once. This is supported by
 formatting the cron spec like this:
 
+```
     @at <datetime>
+```
 
-Where "datetime" is a string accepted by time.Parse in RFC3339 format
-(<https://golang.org/pkg/time/#Parse>).
+Where "datetime" is a string accepted by time.Parse in RFC3339 format https://golang.org/pkg/time/#Parse.
 
 For example, "@at 2018-01-02T15:04:00Z" would run the job on the specified date and time
 assuming UTC timezone.
@@ -103,7 +105,7 @@ job definition.
 If the time zone is not specified, the following rules apply:
 
 All interpretation and scheduling is done in the machine's local time zone (as
-provided by the Go time package (<http://www.golang.org/pkg/time>).
+provided by the Go time package http://www.golang.org/pkg/time.
 
 Be aware that jobs scheduled during daylight-savings leap-ahead transitions will
 not be run!

diff --git a/website/package.json b/website/package.json
@@ -14,9 +14,9 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.2.0",
-    "@docusaurus/preset-classic": "^2.2.0",
-    "@docusaurus/theme-mermaid": "^2.2.0",
+    "@docusaurus/core": "^3.0.1",
+    "@docusaurus/preset-classic": "^3.0.1",
+    "@docusaurus/theme-mermaid": "^3.0.1",
     "@heroicons/react": "^1.0.5",
     "@mdx-js/react": "^1.6.21",
     "autoprefixer": "^10.4.2",
@@ -27,9 +27,9 @@
     "postcss": "^8.4.6",
     "postcss-import": "^14.0.2",
     "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.1",
+    "react": "^18.2.0",
     "react-countup": "^6.2.0",
-    "react-dom": "^17.0.1",
+    "react-dom": "^18.2.0",
     "redocusaurus": "^1.0.2",
     "stream": "^0.0.2",
     "swagger-ui-react": "^4.5.2",

diff --git a/website/src/pages/license.md b/website/src/pages/license.md
@@ -3,5 +3,5 @@
 Copyright (c) Victor Castell
 
 Dkron is an Open Source project licensed under the terms of
-the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+the LGPLv3 license.  Please see http://www.gnu.org/licenses/lgpl-3.0.html
 for license text.
diff --git a/website/versioned_docs/version-v1/basics/getting-started.md b/website/versioned_docs/version-v1/basics/getting-started.md
@@ -25,9 +25,9 @@ All the execution responses will be gathered by the scheduler and stored in the
 
 Dkron relies on the key-value store for data storage, an instance of the distributed store can be run in the same machines as Dkron or connect it to an already existing cluster.
 
-{{% notice note %}}
+:::note
 By default dkron will start with a file based, embedded KV store called BoltDB, it is functional for a single node demo but does not offers clustering or HA.
-{{% /notice %}}
+:::
 
 It is compatible with etcd, Consul, Zookeeper, Redis, DynamoDB and BoltDB. For instructions on how to install and configure any one of these systems refer to their official sites:
 
@@ -53,9 +53,9 @@ By default Dkron uses the following ports:
 - `8080` for HTTP for the API and Dashboard
 - `6868` for RPC comunication between agents.
 
-{{% notice note %}}
+:::note
 Be sure you have opened this ports (or the ones that you configured) in your firewall or AWS security groups.
-{{% /notice %}}
+:::
 
 By default dkron will use the embedded BoltDB KV store. A different store can be specified setting `backend` and `backend-machines` flag in the config file, env variables or as a command line flag.
 
@@ -67,9 +67,9 @@ dkron agent --server
 
 Time to add the first job:
 
-{{% notice note %}}
+:::note
 This job will only run in just one `dkron_server` node due to the node count in the tag. Refer to the [target node spec](/docs/usage/target-nodes-spec) for details.
-{{% /notice %}}
+:::
 
 ```bash
 curl localhost:8080/v1/jobs -XPOST -d '{

diff --git a/website/versioned_docs/version-v1/basics/installation.md b/website/versioned_docs/version-v1/basics/installation.md
@@ -13,9 +13,9 @@ Run Dkron with default setting: `dkron agent --server`
 Navigate to http://localhost:8080
 
 
-{{% notice note %}}
+:::note
 By default dkron will start with a file based, embedded KV store called BoltDB, it is functional for a single node demo but does not offers clustering or HA.
-{{% /notice %}}
+:::
 
 ## Installing the package
 

diff --git a/website/versioned_docs/version-v1/intro/license.md b/website/versioned_docs/version-v1/intro/license.md
@@ -7,5 +7,5 @@ toc: false
 Copyright (c) Victor Castell
 
 Dkron is an Open Source project licensed under the terms of
-the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+the LGPLv3 license.  Please see http://www.gnu.org/licenses/lgpl-3.0.html
 for license text.
diff --git a/website/versioned_docs/version-v1/pro/encryption.md b/website/versioned_docs/version-v1/pro/encryption.md
@@ -12,9 +12,9 @@ By default Dkron Pro runs with automatically generated SSL certificates, this is
 
 Follow [this tutorial](https://coreos.com/os/docs/latest/generate-self-signed-certificates.html) to generate autosigned SSL certificates for your instances.
 
-{{% notice note %}}
+:::note
 You don't need a client certificate for Dkron server, just add "client auth" usage to your server cert.
-{{% /notice %}}
+:::
 
 ```yaml
 # dkron.yaml

diff --git a/website/versioned_docs/version-v1/usage/cron-spec.md b/website/versioned_docs/version-v1/usage/cron-spec.md
@@ -69,7 +69,9 @@ You may use one of several pre-defined schedules in place of a cron expression.
 You may also schedule a job to execute at fixed intervals.  This is supported by
 formatting the cron spec like this:
 
+```
     @every <duration>
+```
 
 where "duration" is a string accepted by time.ParseDuration
 (http://golang.org/pkg/time/#ParseDuration).
@@ -86,7 +88,9 @@ it will have only 2 minutes of idle time between each run.
 You may also want to schedule a job to be executed once. This is supported by
 formatting the cron spec like this:
 
+```
     @at <datetime>
+```
 
 Where "datetime" is a string accepted by time.Parse in RFC3339 format
 (https://golang.org/pkg/time/#Parse).

diff --git a/website/versioned_docs/version-v1/usage/ecs.md b/website/versioned_docs/version-v1/usage/ecs.md
@@ -2,9 +2,9 @@
 title: Use with AWS ECS
 ---
 
-{{% notice note %}}
+:::note
 [Dkron Pro](/pro) comes with a [native ECS executor](/docs/v1/pro/executors/ecs) out of the box.
-{{% /notice %}}
+:::
 
 ## Use with Amazon ECS
 

diff --git a/website/versioned_docs/version-v1/usage/plugins/develop.md b/website/versioned_docs/version-v1/usage/plugins/develop.md
@@ -5,7 +5,9 @@ weight: 99
 
 ## Developing a Plugin
 
-{{% alert theme="warning" %}}**Advanced topic!** Plugin development is a highly advanced topic, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading the following section of the documentation.{{% /alert %}}
+:::warning
+**Advanced topic!** Plugin development is a highly advanced topic, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading the following section of the documentation.
+:::
 
 Developing a plugin is simple. The only knowledge necessary to write a plugin is basic command-line skills and basic knowledge of the Go programming language.
 

diff --git a/website/versioned_docs/version-v1/usage/target-nodes-spec.md b/website/versioned_docs/version-v1/usage/target-nodes-spec.md
@@ -7,9 +7,9 @@ weight: 10
 
 You can choose whether a job is run on a node or nodes by specifying tags and a count of target nodes having this tag do you want a job to run.
 
-{{% notice note %}}
+:::note
 The target node syntax: `[tag-value]:[count]`
-{{% /notice %}}
+:::
 
 ### Examples:
 

diff --git a/website/versioned_docs/version-v2/basics/getting-started.md b/website/versioned_docs/version-v2/basics/getting-started.md
@@ -41,9 +41,9 @@ By default Dkron uses the following ports:
 - `8080` for HTTP for the API and Dashboard
 - `6868` for gRPC and raft layer comunication between agents.
 
-{{% notice note %}}
+:::note
 Be sure you have opened this ports (or the ones that you configured) in your firewall or AWS security groups.
-{{% /notice %}}
+:::
 
 ### Starting a single node
 
@@ -60,9 +60,9 @@ Check your server is working: `curl localhost:8080/v1`
 
 Simple as that, now it is time to add a job:
 
-{{% notice note %}}
+:::note
 This job will only run in just one `server` node due to the node count in the tag. Refer to the [target node spec](/docs/usage/target-nodes-spec) for details.
-{{% /notice %}}
+:::
 
 ```bash
 curl localhost:8080/v1/jobs -XPOST -d '{

diff --git a/website/versioned_docs/version-v2/intro/license.md b/website/versioned_docs/version-v2/intro/license.md
@@ -7,5 +7,5 @@ toc: false
 Copyright (c) Victor Castell
 
 Dkron is an Open Source project licensed under the terms of
-the LGPLv3 license.  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+the LGPLv3 license.  Please see http://www.gnu.org/licenses/lgpl-3.0.html
 for license text.
diff --git a/website/versioned_docs/version-v2/pro/acls.md b/website/versioned_docs/version-v2/pro/acls.md
@@ -4,9 +4,9 @@ title: Access Control
 
 # Access Control (Preview)
 
-{{% notice info %}}
+:::info
 This feature is in preview and is subject to big changes
-{{% /notice %}}
+:::
 
 Dkron provides an optional Access Control List (ACL) system which can be used to control access to data and APIs. The ACL is Capability-based, relying on policies to determine which fine grained rules can be applied. Dkron's capability based ACL system is very similar to common ACL systems you are used to.
 
@@ -20,9 +20,9 @@ The ACL system is designed to be easy to use and fast to enforce while providing
 
 * **ACL Policies.** Dkron's ACL policies are simple JSON documents that define patterns to allow access to resources. You can find below an example ACL policy that works with the default OPA policy. The ACL JSON structure is not rigid you can adapt it to add new features in combination with the OPA Policy rules.
 
-{{% notice note %}}
+:::note
 This guide is based on the usage of the default OPA Rego Policy
-{{% /notice %}}
+:::
 
 ## Configuring ACLs
 

diff --git a/website/versioned_docs/version-v2/pro/encryption.md b/website/versioned_docs/version-v2/pro/encryption.md
@@ -12,9 +12,9 @@ By default Dkron Pro runs with automatically generated SSL certificates, this is
 
 Follow [this tutorial](https://coreos.com/os/docs/latest/generate-self-signed-certificates.html) to generate autosigned SSL certificates for your instances.
 
-{{% notice note %}}
+:::note
 You don't need a client certificate for Dkron server, just add "client auth" usage to your server cert.
-{{% /notice %}}
+:::
 
 ```yaml
 # dkron.yaml

diff --git a/website/versioned_docs/version-v2/pro/failover.md b/website/versioned_docs/version-v2/pro/failover.md
@@ -4,6 +4,6 @@ title: Cross region failover
 
 Dkron Pro can run federated in failover mode, this allows to have two clusters running in different regions and configure one of the clusters in an active-passive fashion, doing a failover in case the active cluster dies.
 
-{{% notice note %}}
+:::note
 This feature is experimental and should be handled with care.
-{{% /notice %}}
+:::
diff --git a/website/versioned_docs/version-v2/usage/cron-spec.md b/website/versioned_docs/version-v2/usage/cron-spec.md
@@ -70,7 +70,9 @@ You may use one of several pre-defined schedules in place of a cron expression.
 You may also schedule a job to execute at fixed intervals.  This is supported by
 formatting the cron spec like this:
 
+```
     @every <duration>
+```
 
 where "duration" is a string accepted by time.ParseDuration
 (http://golang.org/pkg/time/#ParseDuration).
@@ -87,7 +89,9 @@ it will have only 2 minutes of idle time between each run.
 You may also want to schedule a job to be executed once. This is supported by
 formatting the cron spec like this:
 
+```
     @at <datetime>
+```
 
 Where "datetime" is a string accepted by time.Parse in RFC3339 format
 (https://golang.org/pkg/time/#Parse).

diff --git a/website/versioned_docs/version-v2/usage/ecs.md b/website/versioned_docs/version-v2/usage/ecs.md
@@ -2,9 +2,9 @@
 title: Use with AWS ECS
 ---
 
-{{% notice note %}}
+:::note
 [Dkron Pro](/pro) comes with a [native ECS executor](/docs/v2/pro/executors/ecs) out of the box.
-{{% /notice %}}
+:::
 
 ## Use with Amazon ECS
 

diff --git a/website/versioned_docs/version-v2/usage/plugins/develop.md b/website/versioned_docs/version-v2/usage/plugins/develop.md
@@ -5,7 +5,9 @@ weight: 99
 
 ## Developing a Plugin
 
-{{% alert theme="warning" %}}**Advanced topic!** Plugin development is a highly advanced topic, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading the following section of the documentation.{{% /alert %}}
+:::warning
+**Advanced topic!** Plugin development is a highly advanced topic, and is not required knowledge for day-to-day usage. If you don't plan on writing any plugins, we recommend not reading the following section of the documentation.
+:::
 
 Developing a plugin is simple. The only knowledge necessary to write a plugin is basic command-line skills and basic knowledge of the Go programming language.
 

diff --git a/website/versioned_docs/version-v2/usage/recovery.md b/website/versioned_docs/version-v2/usage/recovery.md
@@ -8,9 +8,9 @@ Don't panic! This is a critical first step.
 
 Depending on your deployment configuration, it may take only a single server failure for cluster unavailability. Recovery requires an operator to intervene, but the process is straightforward.
 
-{{% notice note %}}
+:::note
 This guide is for recovery from a Dkron outage due to a majority of server nodes in a datacenter being lost. If you are looking to add or remove servers, see the [clustering](/docs/usage/clustering) guide.
-{{% /notice %}}
+:::
 
 ## Failure of a Single Server Cluster
 

diff --git a/website/versioned_docs/version-v2/usage/target-nodes-spec.md b/website/versioned_docs/version-v2/usage/target-nodes-spec.md
@@ -7,9 +7,9 @@ weight: 10
 
 You can choose whether a job is run on a node or nodes by specifying tags and a count of target nodes having this tag do you want a job to run.
 
-{{% notice note %}}
+:::note
 The target node syntax: `[tag-value]:[count]`
-{{% /notice %}}
+:::
 
 ### Examples: