Merge pull request #2635 from dolthub/gitbook-dev

tbantle22 · web-flow · commit 080ac1eee105 · 2025-07-29T14:51:53.000Z
publish
diff --git a/packages/dolt/content/.gitbook/assets/okta-my-apps.png b/packages/dolt/content/.gitbook/assets/okta-my-apps.png
diff --git a/packages/dolt/content/introduction/use-cases/manual-data-curation.md b/packages/dolt/content/introduction/use-cases/manual-data-curation.md
@@ -4,16 +4,16 @@ title: Manual Data Curation
 
 # Problem
 
-* Are you using spreadsheets to curate production data? 
-* Is the process of merging and reviewing everyone’s changes getting out of hand? 
-* Are bad data changes causing production issues? 
-* Would human review of cell-level data changes help?
+- Are you using spreadsheets to curate production data?
+- Is the process of merging and reviewing everyone’s changes getting out of hand?
+- Are bad data changes causing production issues?
+- Would human review of cell-level data changes help?
 
 # Dolt solves this by…
 
 Dolt allows you to treat your spreadsheet like code. DoltHub and DoltLab implement a [Pull Request workflow](../../concepts/dolthub/prs.md) on tables, the standard for reviewing code changes. Extend that model to your data changes. Make changes on [branches](../../concepts/dolt/git/branch.md) and then have the changes human reviewed. Data diffs are easily consumed by a human reviewer. Add continuous integration tests to data changes. Have dozens or hundreds of changes in flight at one time.
 
-DoltHub and DoltLab support [SQL](../../concepts/dolt/sql/README.md), File Upload (CSV), and a spreadsheet editor for data modification. These interfaces are simple enough that non-technical users can make and review data changes. 
+DoltHub and DoltLab support [SQL](../../concepts/dolt/sql/README.md), File Upload (CSV), and a spreadsheet editor for data modification. These interfaces are simple enough that non-technical users can make and review data changes.
 
 Dolt is a MySQL compatible database so exporting the manually created data to production can be as simple as cloning a copy and starting a server for your developers to connect to.
 
@@ -25,22 +25,20 @@ Dolt replaces Excel or Google Sheets for manual data curation. Versioning featur
 
 # Companies Doing This
 
-* [Annalise](https://usa.annalise.ai/)
-* [Briya](https://briya.com/)
-* [Aktify](https://aktify.com/) 
-* [Blonk Sustainability](https://blonksustainability.nl/)
-* [IMTF](https://imtf.com/)
-* [Lumicks](https://lumicks.com/)
-* [Merkle Science](https://www.merklescience.com/)
-* [Idearoom](https://www.idearoom.com/)
+- [Annalise](https://annalise.ai/)
+- [Briya](https://briya.com/)
+- [Aktify](https://aktify.com/)
+- [Blonk Sustainability](https://blonksustainability.nl/)
+- [IMTF](https://imtf.com/)
+- [Lumicks](https://lumicks.com/)
+- [Merkle Science](https://www.merklescience.com/)
+- [Idearoom](https://www.idearoom.com/)
 
 # Case Studies
 
-* [Aktify](https://www.dolthub.com/blog/2021-10-01-dolt-aktify/)
+- [Aktify](https://www.dolthub.com/blog/2021-10-01-dolt-aktify/)
 
 # Other Related Articles
 
-* [So you want Spreadsheet Version Control?](https://www.dolthub.com/blog/2022-07-15-so-you-want-spreadsheet-version-control/)
-* [Edit like a Spreadsheet V1](https://www.dolthub.com/blog/2021-10-04-edit-like-spreadsheet-v1/)
-
-
+- [So you want Spreadsheet Version Control?](https://www.dolthub.com/blog/2022-07-15-so-you-want-spreadsheet-version-control/)
+- [Edit like a Spreadsheet V1](https://www.dolthub.com/blog/2021-10-04-edit-like-spreadsheet-v1/)
diff --git a/packages/dolt/content/other/faq.md b/packages/dolt/content/other/faq.md
@@ -19,11 +19,11 @@ not taken in the standard command line lexicon. So,
 
 ## Dolt is MySQL-compatible. I use Postgres?
 
-We released a Postgres version of Dolt called [DoltgreSQL](https://github.com/dolthub/doltgresql). 
+We released a Postgres version of Dolt called [DoltgreSQL](https://github.com/dolthub/doltgresql).
 
-However, Dolt is a production-grade version controlled database today. 
-[Dolt is 1.0](https://www.dolthub.com/blog/2023-05-05-dolt-1-dot-0/). 
-If you are ok with using a MySQL-client, we recommend using Dolt for 
+However, Dolt is a production-grade version controlled database today.
+[Dolt is 1.0](https://www.dolthub.com/blog/2023-05-05-dolt-1-dot-0/).
+If you are ok with using a MySQL-client, we recommend using Dolt for
 all use cases. Doltgres is experimental.
 
 ## What does `@@autocommit` do?
@@ -84,14 +84,14 @@ for many popular ORMs and tools.
 
 If you try it and it doesn't work, [let
 us know with an issue](https://github.com/dolthub/dolt/issues) or in
-[our Discord](https://discord.gg/s8uVgc3) and we'll [fix it in 24 hours](https://www.dolthub.com/blog/2024-05-15-24-hour-bug-fixes/). 
+[our Discord](https://discord.gg/s8uVgc3) and we'll [fix it in 24 hours](https://www.dolthub.com/blog/2024-05-15-24-hour-bug-fixes/).
 Our goal is to be a 100% drop-in replacement for MySQL.
 
 ## Why does Dolt use so much disk space?
 
 Dolt generates a lot of garbage during some writes, especially during initial import. It's not
 unusual to get a local storage size of 20x the actual data size after an import. Running `dolt gc`
-will remove the garbage and reclaim local storage. See the [docs on `dolt gc`](../reference/cli/cli.md#dolt-gc) 
+will remove the garbage and reclaim local storage. See the [docs on `dolt gc`](../reference/cli/cli.md#dolt-gc)
 and the [`dolt_gc` stored procedure](../reference/sql/version-control/dolt-sql-procedures.md#dolt_gc) for details.
 
 If you are concerned about the growth of a Dolt database at steady state while running the SQL server, there is [an experimental feature](../reference/sql/server/garbage-collection.md#automated-gc) to automatically run `dolt_gc()` as the database grows.
@@ -131,13 +131,13 @@ call dolt_stats_purge();
 
 Version incompatibilities should not hinder the purge command, but if
 manual intervention is desirable a specific database's
-stats cache can be removed from the filestystem:
+stats cache can be removed from the filesystem:
 
 ```bash
 rm -rf .dolt/stats
 ```
 
 Statistics can be recollected at any time to improve join and indexing
 execution performance. See
-[the stats docs](../reference/sql/sql-support/miscellaneous#stats-controller-functions)
+[the stats docs](../reference/sql/sql-support/miscellaneous.md#stats-controller-functions)
 for more details.
diff --git a/packages/dolt/content/products/hosted/sso.md b/packages/dolt/content/products/hosted/sso.md
@@ -20,7 +20,7 @@ layers of security.
 
 This is what a SAML SSO workflow looks like on Hosted Dolt:
 
-![SAML workflow](../../.gitbook/assets/hosted-sso-saml-diagram.png)
+![](../../.gitbook/assets/hosted-sso-saml-diagram.png)
 
 ## How to set up SSO for your Hosted organization
 
@@ -34,7 +34,7 @@ organization](https://hosted.doltdb.com/organizations). In order to set up SSO,
 required that your organization has at least one bootstrap admin user at all times that
 was not created through the SAML workflow.
 
-![Create organization](../../.gitbook/assets/hosted-create-org.png)
+![](../../.gitbook/assets/hosted-create-org.png)
 
 ### 2. Set up your third-party IdP
 
@@ -45,26 +45,26 @@ First, you must create an [Okta Developer Edition
 Organization](https://developer.okta.com/signup/). Then, navigate to Applications >
 Applications and create a new app integration.
 
-![Okta new app integration](../../.gitbook/assets/okta-new-app-integration.png)
+![](../../.gitbook/assets/okta-new-app-integration.png)
 
 Give your app a name and (optional) logo.
 
-![Okta create SAML integration general settings](../../.gitbook/assets/okta-create-saml-integration-general.png)
+![](../../.gitbook/assets/okta-create-saml-integration-general.png)
 
 Fill out the SAML settings. You can find this information in the SSO tab of your
 organization on Hosted.
 
-![Okta create SAML integration configure SAML](../../.gitbook/assets/okta-create-saml-integration-configure.png)
+![](../../.gitbook/assets/okta-create-saml-integration-configure.png)
 
 If you'd like to add a signature certificate to verify the digital signatures, you can
 download the certificate from your Hosted organization's SSO page and upload it in
 Advanced Settings.
 
-![Okta create SAML integration advanced settings](../../.gitbook/assets/okta-create-saml-integration-advanced-settings.png)
+![](../../.gitbook/assets/okta-create-saml-integration-advanced-settings.png)
 
 Once your SAML integration is created it should look something like this:
 
-![Okta SAML integration](../../.gitbook/assets/okta-saml-integration.png)
+![](../../.gitbook/assets/okta-saml-integration.png)
 
 Download the metadata details from the provided Metadata URL. You'll need this when you
 add this identity provider to your Hosted organization.
@@ -76,33 +76,33 @@ curl -OL https://dev-99612740.okta.com/app/exkb7ksuh3Jn9h90I5d7/sso/saml/metadat
 Then in the Assignments tab, choose some People or Groups to assign to your integration.
 These people or groups will have single sign on into your Hosted organization.
 
-![Okta assign people](../../.gitbook/assets/okta-saml-assign-people.png)
+![](../../.gitbook/assets/okta-saml-assign-people.png)
 
 ### 3. Set up Hosted with the metadata from your IdP
 
 Now back to the Hosted website. In the SSO tab of your organization, add the metadata
 descriptor you downloaded from your Okta integration and click `Configure`.
 
-![Create SAML provider form](../../.gitbook/assets/hosted-configure-saml-sso.png)
+![](../../.gitbook/assets/hosted-configure-saml-sso.png)
 
 You can now share your organization's SSO login url (in this case
 https://hosted.doltdb.com/organizations/mycompany/sso) with the people you added to your
 Okta integration. They'll also have this link when they log in to their Okta account.
 
-![Okta My Apps](../../.gitbook/assets/okta-my-apps.png)
+![](../../.gitbook/assets/okta-my-apps.png)
 
 ### 4. Signing in to your organization's login URL
 
 When people from your Okta integration navigate to your organization's Login URL, they'll
 be redirected to the Okta SSO URL and prompted to log in (if they aren't already).
 
-![Okta SSO login](../../.gitbook/assets/okta-sso-url.png)
+![](../../.gitbook/assets/okta-sso-url.png)
 
 After successfully entering their Okta credentials, the Hosted website will check if a
 user exists that matches the Name ID from the SAML response from Okta. If a Hosted user
 does not already exist, they will be prompted for an email and username.
 
-![Create SAML account](../../.gitbook/assets/hosted-create-saml-account.png)
+![](../../.gitbook/assets/hosted-create-saml-account.png)
 
 The user will receive an email to verify their email address and automatically be added as
 a member to your organization. In the future when they log in they will be immediately
diff --git a/packages/dolt/content/reference/sql/supported-clients/clients.md b/packages/dolt/content/reference/sql/supported-clients/clients.md
@@ -12,7 +12,7 @@ Once a server is running, any MySQL client should be able to connect to Dolt SQL
 $ mysql -u root
 Welcome to the MySQL monitor.  Commands end with ; or \g.
 Your MySQL connection id is 2
-Server version: 5.7.9-Vitess 
+Server version: 5.7.9-Vitess
 
 Copyright (c) 2000, 2022, Oracle and/or its affiliates.
 
@@ -71,7 +71,7 @@ We support the standard `mysql` Node library.
 
 We support the Java client distributed on the MySQL website called `mysql-connector-java`. For our test we use the architecture independent build.
 
-- [Official Client Documentation](https://dev.mysql.com/doc/connector-j/8.0/en/)
+- [Official Client Documentation](https://dev.mysql.com/doc/connector-j/en/)
 - [Java mysql-connector test code](https://github.com/dolthub/dolt/blob/main/integration-tests/mysql-client-tests/java/MySQLConnectorTest.java)
 
 ## C
@@ -93,10 +93,12 @@ We support `mysql-connector-cpp`. Getting it to work correctly required we check
 We support [MySQL.Data.MySqlClient](https://dev.mysql.com/doc/connector-net/en/) distributed by MySQL and the asynchronous [MySqlConnector](https://mysqlconnector.net/). On OSX and Ubuntu we tested the client using [.Net core SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1).
 
 ### MySQL.Data.MySqlClient
+
 - [Official Client Documentation](https://dev.mysql.com/doc/connector-net/en/)
 - [MySql.Data test code](https://github.com/dolthub/dolt/blob/main/integration-tests/mysql-client-tests/dotnet/MySqlClient/Program.cs)
 
 ### MySQLConnector
+
 - [Official Client Documentation](https://mysqlconnector.net/)
 - [MySqlConnector test code](https://github.com/dolthub/dolt/blob/main/integration-tests/mysql-client-tests/dotnet/MySqlConnector/Program.cs)
 
@@ -108,6 +110,7 @@ We support the [DBD::mysql](https://metacpan.org/pod/DBD::mysql) package that im
 - [DBD:mysql test code](https://github.com/dolthub/dolt/blob/main/integration-tests/mysql-client-tests/perl/dbd-mysql-test.pl)
 
 ## PHP
+
 We support the built in [mysqli](https://www.php.net/manual/en/book.mysqli.php) extension and [PDO](https://www.php.net/manual/en/book.pdo.php) API for connecting to MySQL.
 
 - [Official mysqli Client Documentation](https://www.php.net/manual/en/book.mysqli.php)
@@ -127,10 +130,12 @@ We support the [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) pac
 We support the native [ruby/mysql](http://www.tmtm.org/en/ruby/mysql/) library and the native [mysql2](https://github.com/brianmario/mysql2) library. The [mysql/ruby](http://www.tmtm.org/en/mysql/ruby/) package uses the MySQL C API and [has not been ported to MySQL client version 8](https://github.com/luislavena/mysql-gem/issues/35). Thus, we do not support `mysql/ruby`.
 
 ### mysql2
+
 - [Official Client Documentation](https://www.rubydoc.info/gems/mysql2)
 - [mysql2 test code](https://github.com/dolthub/dolt/blob/main/integration-tests/mysql-client-tests/ruby/mysql2-test.rb)
 
 ### ruby/mysql
+
 - [Official Client Documentation](http://www.tmtm.org/en/ruby/mysql/)
 - [ruby/mysql test code](https://github.com/dolthub/dolt/blob/main/integration-tests/mysql-client-tests/ruby/ruby-mysql-test.rb)
 
diff --git a/packages/dolt/content/reference/sql/version-control/querying-history.md b/packages/dolt/content/reference/sql/version-control/querying-history.md
@@ -107,7 +107,7 @@ ORDER BY state, to_commit_date;
 ```
 
 For more information, see the [system table
-docs](dolt-system-tables.md).
+docs](./dolt-system-tables.md).
 
 ## Querying historical view data
 
diff --git a/packages/doltgres/content/concepts/rdbms/backups.md b/packages/doltgres/content/concepts/rdbms/backups.md
@@ -39,7 +39,7 @@ Using a [remote](../git/remotes.md) for backup allows you to back up all committ
 a remote using the [`select dolt_remote()`
 function](../../reference/sql/version-control/dolt-sql-functions.md#dolt_remote). Then you push a
 branch to a remote using the [`dolt_push()`
-function](../../reference/sql/version-control/dolt-sql-function.md#dolt_push).
+function](../../reference/sql/version-control/dolt-sql-functions.md#dolt_push).
 
 ## Not yet supported: non-remote backups
 
diff --git a/packages/doltgres/content/reference/sql/version-control/README.md b/packages/doltgres/content/reference/sql/version-control/README.md
@@ -27,5 +27,3 @@ system variables, functions, and stored procedures.
 - [System variables](./dolt-sysvars.md) documents all the
   Doltgres-provided system variables that expose and control various
   aspects of Doltgres's behavior.
-- [Saved Queries](./saved-queries.md) documents a Doltgres feature to save
-  queries for later execution.
diff --git a/packages/doltgres/content/reference/sql/version-control/dolt-sql-functions.md b/packages/doltgres/content/reference/sql/version-control/dolt-sql-functions.md
@@ -69,7 +69,7 @@ SELECT DOLT_ADD('.');
 ```
 
 Version control features that only inspect the state of the database are modeled as [system
-tables](./dolt_system_tables.md) or [table functions](#table-functions) instead.
+tables](./dolt-system-tables.md) or [table functions](#table-functions) instead.
 
 The functions in this section are also available as stored procedures. Whether you access them as
 functions or as procedures is up to you. The main difference is that in Postgres, stored procedures
diff --git a/packages/doltlab/content/guides/installation/README.md b/packages/doltlab/content/guides/installation/README.md
@@ -8,42 +8,42 @@ You must have a host(s) running a supported operating system, hardware that meet
 
 # Supported operating systems
 
-- [Linux](./installation/linux.md)
+- [Linux](./linux.md)
 
 # Minimum recommended hardware
 
 DoltLab requires the following minimum system resources:
 
-* 4 CPU
-* 16 GB of memory
-* 300 GB of disk (DoltLab's container images alone require about 4 GBs of disk).
+- 4 CPU
+- 16 GB of memory
+- 300 GB of disk (DoltLab's container images alone require about 4 GBs of disk).
 
 # Networking requirements
 
 DoltLab requires the following networking configuration:
 
-* The IP address or domain name of the host must be discoverable by the Dolt CLI and web browser.
-* Hosts must allow egress `TCP` connections.
-* The following ports _must_ allow `TCP` connections:
-  * `22`, for `ssh` connections.
-  * `80`, for ingress `HTTP` connections.
-  * `443` for ingress `HTTPS` connections, if DoltLab will use TLS.
-  * `100`, for ingress connections to DoltLab's [remote data file server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server). This is only required for DoltLab <= `v2.3.7`.
-  * `50051`, for ingress connections to DoltLab's [remote API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server).
-  * `4321`, for ingress connections to DoltLab's [file upload service API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-file-service-api-server).
+- The IP address or domain name of the host must be discoverable by the Dolt CLI and web browser.
+- Hosts must allow egress `TCP` connections.
+- The following ports _must_ allow `TCP` connections:
+  - `22`, for `ssh` connections.
+  - `80`, for ingress `HTTP` connections.
+  - `443` for ingress `HTTPS` connections, if DoltLab will use TLS.
+  - `100`, for ingress connections to DoltLab's [remote data file server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server). This is only required for DoltLab <= `v2.3.7`.
+  - `50051`, for ingress connections to DoltLab's [remote API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server).
+  - `4321`, for ingress connections to DoltLab's [file upload service API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-file-service-api-server).
 
 # Dependencies
 
 DoltLab requires the following dependencies:
 
-> [curl](https://www.tecmint.com/install-curl-in-linux/)<br/>
-> [unzip](https://www.tecmint.com/install-zip-and-unzip-in-linux/)<br/>
-> [docker](https://docs.docker.com/engine/install/)<br/>
-> [docker-compose](https://docs.docker.com/compose/install/)<br/>
-> [amazon-ecr-credential-helper](https://github.com/awslabs/amazon-ecr-credential-helper)<br/>
-> Access to an [SMTP server](https://aws.amazon.com/what-is/smtp/), like [smtp.gmail.com](https://support.google.com/a/answer/176600?hl=en).
+- [curl](https://www.tecmint.com/install-curl-in-linux/)
+- [unzip](https://www.tecmint.com/install-zip-and-unzip-in-linux/)
+- [docker](https://docs.docker.com/engine/install/)
+- [docker-compose](https://docs.docker.com/compose/install/)
+- [amazon-ecr-credential-helper](https://github.com/awslabs/amazon-ecr-credential-helper)
+- Access to an [SMTP server](https://aws.amazon.com/what-is/smtp/), like [smtp.gmail.com](https://support.google.com/a/answer/176600?hl=en).
 
-To streamline dependency installation, with DoltLab >= `v2.1.2` you can run the [installer](../reference/installer.md) with one of the following flags to generate a dependency installation script:
+To streamline dependency installation, with DoltLab >= `v2.1.2` you can run the [installer](../../reference/installer.md) with one of the following flags to generate a dependency installation script:
 
 ```bash
 # generate a script to install DoltLab dependencies on Ubuntu
