Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor Castell committed Sep 2, 2023
1 parent 383355f commit 28ea7f7
Show file tree
Hide file tree
Showing 15 changed files with 273 additions and 18 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

## [3.2.6] - 2023-09-02

### Changes

- Bump deps & update docs

## [3.2.5] - 2023-06-15

### Changes

- Bump deps

## [3.2.4] - 2023-05-29

### Fixes
Expand Down
5 changes: 3 additions & 2 deletions website/docs/pro/cli/dkron.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron"
slug: dkron
url: /docs/pro/cli/dkron/
Expand All @@ -24,10 +24,11 @@ If a machine fails (the leader), a follower will take over and keep running the
### SEE ALSO

* [dkron agent](/docs/pro/cli/dkron_agent/) - Start a dkron agent
* [dkron completion](/docs/pro/cli/dkron_completion/) - Generate the autocompletion script for the specified shell
* [dkron doc](/docs/pro/cli/dkron_doc/) - Generate Markdown documentation for the Dkron CLI.
* [dkron keygen](/docs/pro/cli/dkron_keygen/) - Generates a new encryption key
* [dkron leave](/docs/pro/cli/dkron_leave/) - Force an agent to leave the cluster
* [dkron raft](/docs/pro/cli/dkron_raft/) - Command to perform some raft operations
* [dkron version](/docs/pro/cli/dkron_version/) - Show version

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_agent.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron agent"
slug: dkron_agent
url: /docs/pro/cli/dkron_agent/
Expand Down Expand Up @@ -122,4 +122,4 @@ dkron agent [flags]

* [dkron](/docs/pro/cli/dkron/) - Professional distributed job scheduling system

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
37 changes: 37 additions & 0 deletions website/docs/pro/cli/dkron_completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
date: 2023-09-02
title: "dkron completion"
slug: dkron_completion
url: /docs/pro/cli/dkron_completion/
---
## dkron completion

Generate the autocompletion script for the specified shell

### Synopsis

Generate the autocompletion script for dkron for the specified shell.
See each sub-command's help for details on how to use the generated script.


### Options

```
-h, --help help for completion
```

### Options inherited from parent commands

```
--config string config file (default is /etc/dkron/dkron.yml)
```

### SEE ALSO

* [dkron](/docs/pro/cli/dkron/) - Professional distributed job scheduling system
* [dkron completion bash](/docs/pro/cli/dkron_completion_bash/) - Generate the autocompletion script for bash
* [dkron completion fish](/docs/pro/cli/dkron_completion_fish/) - Generate the autocompletion script for fish
* [dkron completion powershell](/docs/pro/cli/dkron_completion_powershell/) - Generate the autocompletion script for powershell
* [dkron completion zsh](/docs/pro/cli/dkron_completion_zsh/) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 2-Sep-2023
56 changes: 56 additions & 0 deletions website/docs/pro/cli/dkron_completion_bash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
date: 2023-09-02
title: "dkron completion bash"
slug: dkron_completion_bash
url: /docs/pro/cli/dkron_completion_bash/
---
## dkron completion bash

Generate the autocompletion script for bash

### Synopsis

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

source <(dkron completion bash)

To load completions for every new session, execute once:

#### Linux:

dkron completion bash > /etc/bash_completion.d/dkron

#### macOS:

dkron completion bash > $(brew --prefix)/etc/bash_completion.d/dkron

You will need to start a new shell for this setup to take effect.


```
dkron completion bash
```

### Options

```
-h, --help help for bash
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--config string config file (default is /etc/dkron/dkron.yml)
```

### SEE ALSO

* [dkron completion](/docs/pro/cli/dkron_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 2-Sep-2023
47 changes: 47 additions & 0 deletions website/docs/pro/cli/dkron_completion_fish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
date: 2023-09-02
title: "dkron completion fish"
slug: dkron_completion_fish
url: /docs/pro/cli/dkron_completion_fish/
---
## dkron completion fish

Generate the autocompletion script for fish

### Synopsis

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

dkron completion fish | source

To load completions for every new session, execute once:

dkron completion fish > ~/.config/fish/completions/dkron.fish

You will need to start a new shell for this setup to take effect.


```
dkron completion fish [flags]
```

### Options

```
-h, --help help for fish
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--config string config file (default is /etc/dkron/dkron.yml)
```

### SEE ALSO

* [dkron completion](/docs/pro/cli/dkron_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 2-Sep-2023
44 changes: 44 additions & 0 deletions website/docs/pro/cli/dkron_completion_powershell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
date: 2023-09-02
title: "dkron completion powershell"
slug: dkron_completion_powershell
url: /docs/pro/cli/dkron_completion_powershell/
---
## dkron completion powershell

Generate the autocompletion script for powershell

### Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

dkron completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command
to your powershell profile.


```
dkron completion powershell [flags]
```

### Options

```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--config string config file (default is /etc/dkron/dkron.yml)
```

### SEE ALSO

* [dkron completion](/docs/pro/cli/dkron_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 2-Sep-2023
58 changes: 58 additions & 0 deletions website/docs/pro/cli/dkron_completion_zsh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
date: 2023-09-02
title: "dkron completion zsh"
slug: dkron_completion_zsh
url: /docs/pro/cli/dkron_completion_zsh/
---
## dkron completion zsh

Generate the autocompletion script for zsh

### Synopsis

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(dkron completion zsh)

To load completions for every new session, execute once:

#### Linux:

dkron completion zsh > "${fpath[1]}/_dkron"

#### macOS:

dkron completion zsh > $(brew --prefix)/share/zsh/site-functions/_dkron

You will need to start a new shell for this setup to take effect.


```
dkron completion zsh [flags]
```

### Options

```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
--config string config file (default is /etc/dkron/dkron.yml)
```

### SEE ALSO

* [dkron completion](/docs/pro/cli/dkron_completion/) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron doc"
slug: dkron_doc
url: /docs/pro/cli/dkron_doc/
Expand Down Expand Up @@ -37,4 +37,4 @@ dkron doc [flags]

* [dkron](/docs/pro/cli/dkron/) - Professional distributed job scheduling system

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_keygen.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron keygen"
slug: dkron_keygen
url: /docs/pro/cli/dkron_keygen/
Expand Down Expand Up @@ -34,4 +34,4 @@ dkron keygen [flags]

* [dkron](/docs/pro/cli/dkron/) - Professional distributed job scheduling system

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_leave.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron leave"
slug: dkron_leave
url: /docs/pro/cli/dkron_leave/
Expand Down Expand Up @@ -41,4 +41,4 @@ dkron leave [flags]

* [dkron](/docs/pro/cli/dkron/) - Professional distributed job scheduling system

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_raft.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron raft"
slug: dkron_raft
url: /docs/pro/cli/dkron_raft/
Expand Down Expand Up @@ -30,4 +30,4 @@ Command to perform some raft operations
* [dkron raft list-peers](/docs/pro/cli/dkron_raft_list-peers/) - Command to list raft peers
* [dkron raft remove-peer](/docs/pro/cli/dkron_raft_remove-peer/) - Command to list raft peers

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_raft_list-peers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron raft list-peers"
slug: dkron_raft_list-peers
url: /docs/pro/cli/dkron_raft_list-peers/
Expand Down Expand Up @@ -32,4 +32,4 @@ dkron raft list-peers [flags]

* [dkron raft](/docs/pro/cli/dkron_raft/) - Command to perform some raft operations

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_raft_remove-peer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron raft remove-peer"
slug: dkron_raft_remove-peer
url: /docs/pro/cli/dkron_raft_remove-peer/
Expand Down Expand Up @@ -33,4 +33,4 @@ dkron raft remove-peer [flags]

* [dkron raft](/docs/pro/cli/dkron_raft/) - Command to perform some raft operations

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023
4 changes: 2 additions & 2 deletions website/docs/pro/cli/dkron_version.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2022-10-07
date: 2023-09-02
title: "dkron version"
slug: dkron_version
url: /docs/pro/cli/dkron_version/
Expand Down Expand Up @@ -32,4 +32,4 @@ dkron version [flags]

* [dkron](/docs/pro/cli/dkron/) - Professional distributed job scheduling system

###### Auto generated by spf13/cobra on 7-Oct-2022
###### Auto generated by spf13/cobra on 2-Sep-2023

0 comments on commit 28ea7f7

Please sign in to comment.