Skip to content

Commit bcfbcd2

Browse files
committed
chore: format docs in a way that will make datum.net happy
Since we want datum.net to correctly render our documentation we need to keep it compliant with their syntax. In practice it means adding the right metadata to our markdown file and remove some code highlighting that is not supported yet for datum.net
1 parent 0108ce9 commit bcfbcd2

File tree

11 files changed

+57
-82
lines changed

11 files changed

+57
-82
lines changed

docs/README.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: "Activity"
3+
sidebar:
4+
order: 3
5+
---
6+
17
# Activity
28

39
The `datumctl activity` command is available for interacting with the [activity
@@ -8,7 +14,7 @@ with the platform.
814
You can see the full list of commands and CLI options by using the `--help`
915
flag.
1016

11-
```shell
17+
```
1218
$ datumctl activity --help
1319
```
1420

@@ -28,7 +34,7 @@ logs to understand what's happening within your organization and projects.
2834
Use the `--project` and `--organization` flag to control which context audit
2935
logs are retrieved from.
3036

31-
```shell
37+
```
3238
$ datumctl activity query --project datum-cloud
3339
TIMESTAMP VERB USER NAMESPACE RESOURCE NAME STATUS
3440
2026-01-14 09:52:43 create [email protected] auditlogqueries 201
@@ -43,7 +49,7 @@ The `--filter` command is available to filter the audit logs returned in the
4349
query. The filter option accepts a [CEL expression][cel] to select which audit
4450
logs should be returned.
4551

46-
```shell
52+
```
4753
$ datumctl activity query --project datum-cloud --limit 10 --filter='user.username == "[email protected]" && objectRef.apiGroup == "networking.datumapis.com"'
4854
TIMESTAMP VERB USER NAMESPACE RESOURCE NAME STATUS
4955
2026-01-14 10:08:33 get [email protected] default domains datum.net 200
@@ -62,7 +68,7 @@ The `--continue` option is available to paginate requests when additional
6268
results are available. The CLI will provide the continue option to use for the
6369
next page of requests.
6470

65-
```shell
71+
```
6672
$ datumctl activity query --project datum-cloud --limit 10 --filter='user.username == "[email protected]" && objectRef.apiGroup == "networking.datumapis.com"' --limit 3
6773
TIMESTAMP VERB USER NAMESPACE RESOURCE NAME STATUS
6874
2026-01-14 10:08:33 get [email protected] default domains datum.net 200
@@ -83,7 +89,7 @@ that are helpful to users to understand the activity. You can also output the
8389
results as `yaml` or `json` to see the full audit logs that were retrieved by
8490
the query.
8591

86-
```shell
92+
```
8793
$ datumctl activity query --project datum-cloud -o yaml
8894
apiVersion: audit.k8s.io/v1
8995
items:
Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Authentication
1+
---
2+
title: "Authentication"
3+
sidebar:
4+
order: 2
5+
---
26

37
`datumctl` uses OAuth 2.0 and OpenID Connect (OIDC) with the PKCE extension for
48
secure authentication against Datum Cloud. This avoids the need to handle static
@@ -20,7 +24,7 @@ keyring.
2024

2125
To authenticate with Datum Cloud, use the `login` command:
2226

23-
```bash
27+
```
2428
datumctl auth login [--hostname <auth-hostname>] [-v]
2529
```
2630

@@ -49,7 +53,7 @@ Once logged in, you typically need to configure `kubectl` to authenticate to
4953
Datum Cloud Kubernetes clusters using your `datumctl` login session. Use the
5054
`update-kubeconfig` command:
5155

52-
```bash
56+
```
5357
datumctl auth update-kubeconfig [--kubeconfig <path>] [--project <name>] [--organization <name>]
5458
```
5559

@@ -75,7 +79,7 @@ automatically use your active `datumctl` login session for authentication.
7579

7680
To see which users you have authenticated locally, use the `list` command:
7781

78-
```bash
82+
```
7983
datumctl auth list
8084
# Alias: datumctl auth ls
8185
```
@@ -91,7 +95,7 @@ If you have logged in with multiple user accounts (visible via
9195
`datumctl auth list`), you can switch which account is active using the
9296
`switch` command:
9397

94-
```bash
98+
```
9599
datumctl auth switch <user-email>
96100
```
97101

@@ -108,7 +112,7 @@ To remove stored credentials, use the `logout` command.
108112

109113
**Log out a specific user:**
110114

111-
```bash
115+
```
112116
datumctl auth logout <user-email>
113117
```
114118

@@ -117,7 +121,7 @@ Replace `<user-email>` with the email address shown in the
117121

118122
**Log out all users:**
119123

120-
```bash
124+
```
121125
datumctl auth logout --all
122126
```
123127

@@ -129,7 +133,7 @@ The `get-token` command retrieves the current access token for the *active*
129133
authenticated user. This is primarily used internally by other tools (like
130134
`kubectl`) but can be used directly if needed.
131135

132-
```bash
136+
```
133137
datumctl auth get-token [-o <format>]
134138
```
135139

docs/developer/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/developer/authentication_flow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Authentication flow
1+
---
2+
title: "Authentication flow"
3+
sidebar:
4+
order: 7
5+
---
26

37
`datumctl` utilizes OAuth 2.0 Authorization Code Flow with PKCE (Proof Key for
48
Code Exchange) for user authentication. This flow is orchestrated by the

docs/developer/code_structure.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Code structure
1+
---
2+
title: "Code structure"
3+
sidebar:
4+
order: 6
5+
---
26

37
The `datumctl` codebase is organized primarily within the `internal` directory,
48
following common Go practices.

docs/developer/overview.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Developer overview
1+
---
2+
title: "Overview"
3+
sidebar:
4+
order: 5
5+
---
26

37
`datumctl` is the command-line interface for interacting with Datum Cloud. It is
48
built using Go and the [Cobra](https://cobra.dev/) library for CLI structure.

docs/developer/releases.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: "Releases"
3+
---
14
# Releases
25

36
This guide explains how to cut a `datumctl` release locally with GoReleaser and
Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
1-
# Installation
1+
---
2+
title: "Installation"
3+
sidebar:
4+
order: 1
5+
---
26

3-
This section describes how to install `datumctl`.
7+
Welcome to the documentation for `datumctl`, the command-line interface for
8+
interacting with Datum Cloud.
9+
10+
Let's start installing the binary itself, but if you want to get deeper, make a
11+
contribution or you are a curious developer nativate to the [documentation we
12+
wrote specifically for you.](developer/overview)
413

514
## Homebrew (macOS)
615

716
If you are using macOS and have [Homebrew](https://brew.sh/) installed, you can
817
install `datumctl` via our official tap:
918

10-
```bash
19+
```
1120
# Tap the Datum Cloud formula repository (only needs to be done once)
1221
brew tap datum-cloud/homebrew-tap
1322
@@ -74,7 +83,7 @@ This example shows how to download and install a specific version. You **must**:
7483
architecture found on the releases page (e.g.,
7584
`datumctl_Darwin_arm64.tar.gz`).
7685

77-
```bash
86+
```
7887
VERSION="<version>"
7988
ARCHIVE="<archive_filename>"
8089
curl -sSL "https://github.com/datum-cloud/datumctl/releases/download/${VERSION}/${ARCHIVE}" | tar xz
@@ -93,12 +102,12 @@ If you prefer, you can build `datumctl` from source:
93102
* Go (version 1.21 or later)
94103
* Git
95104
2. **Clone the repository:**
96-
```bash
105+
```
97106
git clone https://github.com/datum-cloud/datumctl.git
98107
cd datumctl
99108
```
100109
3. **Build the binary:**
101-
```bash
110+
```
102111
go build -o datumctl .
103112
```
104113
4. **Install:** Move the resulting `datumctl` binary to a directory in your
@@ -108,7 +117,7 @@ If you prefer, you can build `datumctl` from source:
108117
109118
To verify the installation, run:
110119
111-
```bash
120+
```
112121
datumctl version
113122
```
114123

docs/user/README.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)