11<div align =" center " >
22
3- # The CrateDB Guide
3+ # The CrateDB Handbook
44
5- 📖 _ Guidelines and tutorials about [ CrateDB] ._ 📖
5+ 📖 _ How-to guides, tutorials, explanations, and extended reference material about [ CrateDB] ._ 📖
66
7- 🔗 Handbook:
7+ 🔗 Learning path:
8+ [ Getting Started] ( https://cratedb.com/docs/guide/start/ ) •
89[ Install] ( https://cratedb.com/docs/guide/install/ ) •
9- [ Getting Started] ( https://cratedb.com/docs/guide/getting-started.html ) •
10+ [ How-to guides] ( https://cratedb.com/docs/guide/howto/ ) •
11+ [ Tutorials] ( https://cratedb.com/docs/guide/tutorial/ ) •
1012[ Administration] ( https://cratedb.com/docs/guide/admin/ ) •
1113[ Performance] ( https://cratedb.com/docs/guide/performance/ )
1214
13- 🔗 Ecosystem:
14- [ Application Domains] ( https://cratedb.com/docs/guide/domain/ ) •
15- [ Integrations] ( https://cratedb.com/docs/guide/integrate/ ) •
16- [ Reference Architectures] ( https://cratedb.com/docs/guide/reference-architectures/ )
15+ 🔗 Reference material:
16+ [ All features] ( https://cratedb.com/docs/guide/feature/ ) •
17+ [ Ingestion] ( https://cratedb.com/docs/guide/ingest/ ) •
18+ [ Topics] ( https://cratedb.com/docs/guide/topic/ ) •
19+ [ Solutions] ( https://cratedb.com/docs/guide/solution/ ) •
20+ [ Integrations] ( https://cratedb.com/docs/guide/integrate/ )
1721
1822📖 More information:
19- [ Drivers and Integrations] ( https://cratedb.com/docs/clients/ ) •
20- [ Reference Documentation] ( https://cratedb.com/docs/crate/reference/ )
23+ [ Reference Manual] ( https://cratedb.com/docs/crate/reference/ )
2124
2225✅ CI Status:
2326[ ![ ] ( https://github.com/crate/cratedb-guide/actions/workflows/docs.yml/badge.svg )] ( https://github.com/crate/cratedb-guide/actions/workflows/docs.yml )
3740
3841## 🧐 What's Inside
3942
40- The main content tree of the CrateDB Guide includes a wide array of topics.
43+ The main content tree of the CrateDB Handbook includes an array of topics,
44+ roughly based on two approaches to convey information: A "learning path"
45+ style documentation serving newcomers, and a "reference lookup" style
46+ documentation serving experienced users.
4147
4248If you are looking for something specific, please use the search feature on
4349GitHub, for example, [ searching for "flink"] , or clone the repository and
@@ -58,16 +64,21 @@ The folder structure follows a few conventions and ideas. The order of the items
5864enumerated below is the order how they are currently enumerated within the primary
5965navigation element (left-hand menu).
6066
67+ ** Learning path**
6168- ` start ` The canonical "Getting Started" section, providing an easy user journey.
6269- ` install ` The canonical "How to install CrateDB" section.
6370- ` connect ` The canonical "How to connect to CrateDB" section.
71+ - ` howto ` How-to guides about CrateDB.
72+ - ` tutorial ` Tutorials about CrateDB.
73+ - ` admin ` A potpourri of operational guidelines.
74+ - ` performance ` A potpourri of performance tuning guidelines.
75+
76+ ** Reference material**
6477- ` feature ` A backbone section about all features at a glance, using a flat layout.
6578- ` ingest ` A category section bundling all ingest methods.
6679- ` topic ` A category section bundling different topics [ sic!] and application domains.
67- - ` use ` A category section bundling different successful customer scenarios.
80+ - ` solution ` A category section bundling different successful customer scenarios.
6881- ` integrate ` A backbone section about all the integration items, using a flat layout.
69- - ` admin ` A potpourri of operational guidelines.
70- - ` performance ` A potpourri of performance tuning guidelines.
7182
7283## 💁 Contributing
7384
@@ -93,7 +104,7 @@ Please also refer to the [CrateDB Authoring Guide] for more information.
93104
94105[ contribution docs ] : https://github.com/crate/crate/blob/master/CONTRIBUTING.rst
95106[ CrateDB ] : https://github.com/crate/crate
96- [ CrateDB Authoring Guide ] : https://crate-docs-theme.readthedocs.io/en/latest/authoring.html
107+ [ CrateDB Authoring Guide ] : https://crate-docs-theme.readthedocs.io/en/latest/authoring/
97108[ crate-docs-theme ] : https://crate-docs-theme.readthedocs.io/
98109[ developer docs ] : DEVELOP.md
99110[ Markdown ] : https://daringfireball.net/projects/markdown/
0 commit comments