From ee1d8efe8c383fe9a7a34ad816305ea4e10869df Mon Sep 17 00:00:00 2001 From: Gabor Szarnyas Date: Wed, 21 Aug 2024 15:30:35 +0200 Subject: [PATCH 1/3] Rework documentation landing page --- _data/menu_docs_dev.json | 38 +++++++++++++++++++------------------- docs/data/overview.md | 2 +- docs/index.md | 11 +---------- docs/overview.md | 19 +++++++++++++++++++ 4 files changed, 40 insertions(+), 30 deletions(-) create mode 100644 docs/overview.md diff --git a/_data/menu_docs_dev.json b/_data/menu_docs_dev.json index 050e0ae718a..3189c5631f1 100644 --- a/_data/menu_docs_dev.json +++ b/_data/menu_docs_dev.json @@ -11,7 +11,7 @@ "mainfolderitems": [ { "page": "Overview", - "url": "index" + "url": "overview" }, { "page": "Connect", @@ -377,24 +377,6 @@ } ] }, - { - "page": "Configuration", - "slug": "configuration", - "subfolderitems": [ - { - "page": "Overview", - "url": "overview" - }, - { - "page": "Pragmas", - "url": "pragmas" - }, - { - "page": "Secrets Manager", - "url": "secrets_manager" - } - ] - }, { "page": "SQL", "slug": "sql", @@ -899,6 +881,24 @@ } ] }, + { + "page": "Configuration", + "slug": "configuration", + "subfolderitems": [ + { + "page": "Overview", + "url": "overview" + }, + { + "page": "Pragmas", + "url": "pragmas" + }, + { + "page": "Secrets Manager", + "url": "secrets_manager" + } + ] + }, { "page": "Extensions", "slug": "extensions", diff --git a/docs/data/overview.md b/docs/data/overview.md index 19736e2294e..79041807cfb 100644 --- a/docs/data/overview.md +++ b/docs/data/overview.md @@ -3,7 +3,7 @@ layout: docu title: Importing Data --- -The first step to using a database system is to insert data into that system. DuckDB provides several data ingestion methods that allow you to easily and efficiently fill up the database. In this section, we provide an overview of these methods so you can select which one is correct for you. +The first step to using a database system is to insert data into that system. DuckDB provides several data ingestion methods that allow you to easily and efficiently fill up the database. In this section, we provide an overview of these methods so you can select which one is best suited for your use case. ## Insert Statements diff --git a/docs/index.md b/docs/index.md index 638702a5acd..c745a783526 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,6 @@ --- layout: docu -title: Documentation +title: Sitemap --- -Welcome to the documentation of DuckDB version 1.0! -To see the changes in this release, see the [announcement blog post]({% post_url 2024-06-03-announcing-duckdb-100 %}). - -## Offline Copy - -You can [browse the DuckDB documentation offline](/docs/guides/offline-copy). - -## Sitemap -
diff --git a/docs/overview.md b/docs/overview.md new file mode 100644 index 00000000000..6d7acfbc581 --- /dev/null +++ b/docs/overview.md @@ -0,0 +1,19 @@ +--- +layout: docu +title: Documentation +--- + +Welcome to the DuckDB documentation! + +* [DuckDB connection overview]({% link docs/connect/overview.md %}) +* Client APIs + * [CLI (command line interface)]({% link docs/api/cli/overview.md %}) + * [Java]({% link docs/api/java.md %}) + * [Python]({% link docs/api/python/overview.md %}) + * [R]({% link docs/api/r.md %}) + * [WebAssembly]({% link docs/api/wasm/overview.md %}) + * See all [client APIs]({% link docs/api/overview.md %}) +* SQL + * [SQL introduction]({% link docs/sql/introduction.md %}) + * [SQL statements]({% link docs/sql/statements/overview.md %}) +* [Guides]({% link docs/guides/overview.md %}) From ed6a3b6e2b780310088cb03a4f380b815f2b6ddb Mon Sep 17 00:00:00 2001 From: Gabor Szarnyas Date: Wed, 21 Aug 2024 15:36:50 +0200 Subject: [PATCH 2/3] Add new documentation landing page --- _data/menu_docs_dev.json | 4 ++-- _data/menu_side.json | 2 +- docs/index.md | 19 +++++++++++++++++-- docs/overview.md | 19 ------------------- docs/sitemap.md | 6 ++++++ 5 files changed, 26 insertions(+), 24 deletions(-) delete mode 100644 docs/overview.md create mode 100644 docs/sitemap.md diff --git a/_data/menu_docs_dev.json b/_data/menu_docs_dev.json index 3189c5631f1..f8b489d9574 100644 --- a/_data/menu_docs_dev.json +++ b/_data/menu_docs_dev.json @@ -10,8 +10,8 @@ "slug": "", "mainfolderitems": [ { - "page": "Overview", - "url": "overview" + "page": "Getting Started", + "url": "index" }, { "page": "Connect", diff --git a/_data/menu_side.json b/_data/menu_side.json index 4d99017c144..935e55ddf2c 100644 --- a/_data/menu_side.json +++ b/_data/menu_side.json @@ -2,7 +2,7 @@ "sidemenu": [ { "page": "Sitemap", - "url": "/docs" + "url": "/docs/sitemap" }, { "page": "Why DuckDB", diff --git a/docs/index.md b/docs/index.md index c745a783526..41aba4605a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,21 @@ --- layout: docu -title: Sitemap +title: Documentation --- -
+Welcome to the DuckDB documentation! + +* [DuckDB connection overview]({% link docs/connect/overview.md %}) +* Client APIs + * [CLI (command line interface)]({% link docs/api/cli/overview.md %}) + * [Java]({% link docs/api/java.md %}) + * [Python]({% link docs/api/python/overview.md %}) + * [R]({% link docs/api/r.md %}) + * [WebAssembly]({% link docs/api/wasm/overview.md %}) + * see all [client APIs]({% link docs/api/overview.md %}) +* SQL + * [SQL introduction]({% link docs/sql/introduction.md %}) + * [SQL statements]({% link docs/sql/statements/overview.md %}) +* [Guides]({% link docs/guides/overview.md %}) + +You can also [browse the DuckDB documentation offline]({% link docs/guides/offline-copy.md %}). diff --git a/docs/overview.md b/docs/overview.md deleted file mode 100644 index 6d7acfbc581..00000000000 --- a/docs/overview.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: docu -title: Documentation ---- - -Welcome to the DuckDB documentation! - -* [DuckDB connection overview]({% link docs/connect/overview.md %}) -* Client APIs - * [CLI (command line interface)]({% link docs/api/cli/overview.md %}) - * [Java]({% link docs/api/java.md %}) - * [Python]({% link docs/api/python/overview.md %}) - * [R]({% link docs/api/r.md %}) - * [WebAssembly]({% link docs/api/wasm/overview.md %}) - * See all [client APIs]({% link docs/api/overview.md %}) -* SQL - * [SQL introduction]({% link docs/sql/introduction.md %}) - * [SQL statements]({% link docs/sql/statements/overview.md %}) -* [Guides]({% link docs/guides/overview.md %}) diff --git a/docs/sitemap.md b/docs/sitemap.md new file mode 100644 index 00000000000..c745a783526 --- /dev/null +++ b/docs/sitemap.md @@ -0,0 +1,6 @@ +--- +layout: docu +title: Sitemap +--- + +
From fbacbec40d6d87ef23c6941416bae6647d860fd0 Mon Sep 17 00:00:00 2001 From: Gabor Szarnyas Date: Wed, 21 Aug 2024 15:37:34 +0200 Subject: [PATCH 3/3] Increase approx size of zip --- docs/guides/offline-copy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/offline-copy.md b/docs/guides/offline-copy.md index 8263e46d7f9..b3ac6e684d2 100644 --- a/docs/guides/offline-copy.md +++ b/docs/guides/offline-copy.md @@ -7,7 +7,7 @@ You can browse the DuckDB documentation offline in two formats: * As a [single PDF file](/duckdb-docs.pdf) (approx. 4 MB) -* As a [website packaged in a single ZIP file](/duckdb-docs.zip) (approx. 40 MB). To browse the website locally, decompress the package, navigate to the `duckdb-docs` directory, and run: +* As a [website packaged in a single ZIP file](/duckdb-docs.zip) (approx. 50 MB). To browse the website locally, decompress the package, navigate to the `duckdb-docs` directory, and run: ```bash python -m http.server