Skip to content

Commit e0fd6e5

Browse files
committed
Diátaxis: Add "Explanations" section
1 parent 96cc6fe commit e0fd6e5

File tree

2 files changed

+37
-3
lines changed

2 files changed

+37
-3
lines changed

docs/explain/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
(explain)=
2+
(explanation)=
3+
(explanations)=
4+
5+
# Explanations
6+
7+
:::{div} sd-text-muted
8+
Broaden and deepen your knowledge and understanding of CrateDB subject matters.
9+
:::
10+
11+
The explanatory guides in this section provide more context and background
12+
about applications and use cases of CrateDB, trying to put things into a
13+
bigger picture and joining things together to help answer the question _why_?
14+
15+
16+
17+
:::{note}
18+
You can expect the more recent documents to be more up-to-date than previous
19+
ones. If you can discover any flaws, please report them back to us by
20+
navigating to the tool flyout in the top right corner of each page,
21+
then using "Suggest improvement" to leave your feedback.
22+
:::

docs/handbook/index.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ About using CrateDB and CrateDB Cloud in practice.
77
:::
88

99

10-
::::{grid} 2 2 4 4
10+
::::{grid} 2 2 3 3
1111
:gutter: 2
1212
:padding: 0
1313

@@ -51,7 +51,7 @@ About using CrateDB and CrateDB Cloud in practice.
5151

5252
How-to guides, tutorials, and explanations.
5353

54-
::::{grid} 2 2 4 4
54+
::::{grid} 2 2 3 3
5555
:gutter: 2
5656
:padding: 0
5757

@@ -63,7 +63,7 @@ How-to guides, tutorials, and explanations.
6363
:class-card: sd-pt-3
6464
:class-body: sd-fs-1
6565
:class-title: sd-fs-5
66-
{material-outlined}`assistant_direction;1.3em`
66+
{material-outlined}`integration_instructions;1.3em`
6767
:::
6868

6969
:::{grid-item-card} Tutorials
@@ -77,6 +77,17 @@ How-to guides, tutorials, and explanations.
7777
{material-outlined}`school;1.3em`
7878
:::
7979

80+
:::{grid-item-card} Explanations
81+
:link: explanations
82+
:link-type: ref
83+
:link-alt: Explanations about subject matters concerning CrateDB
84+
:text-align: center
85+
:class-card: sd-pt-3
86+
:class-body: sd-fs-1
87+
:class-title: sd-fs-5
88+
{material-outlined}`lightbulb;1.3em`
89+
:::
90+
8091
:::{grid-item-card} Administration
8192
:link: administration
8293
:link-type: ref
@@ -247,6 +258,7 @@ programming frameworks, software testing, time series data.
247258
../connect/index
248259
../howto/index
249260
../tutorial/index
261+
../explain/index
250262
../admin/index
251263
../performance/index
252264
../feature/index

0 commit comments

Comments
 (0)