Skip to content

Commit

Permalink
Merge pull request #2108 from dolthub/taylor/remove-old
Browse files Browse the repository at this point in the history
Remove doltlab/doltgres product sections and link to new docs sites
  • Loading branch information
tbantle22 authored Apr 11, 2024
2 parents 8c6ad0a + 12fcc05 commit 92cb30e
Show file tree
Hide file tree
Showing 40 changed files with 34 additions and 2,580 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@ title: Dolt Documentation

## Introduction

This repository contains Dolt and DoltHub documentation. Check out our [website](https://www.dolthub.com), [team](https://www.dolthub.com/team), and [documentation](https://docs.dolthub.com/introduction/what-is-dolt) to learn more about Dolt.
This repository contains Dolt, DoltHub, DoltLab, and Postgres documentation. Check out our [website](https://www.dolthub.com), [team](https://www.dolthub.com/team), and documentation to learn more:

- [Dolt](https://docs.dolthub.com)
- [Doltgres](https://docs.doltgres.com)
- [DoltLab](https://docs.doltlab.com)

## GitBook Hosting

We use [GitBook](https://www.gitbook.com/) to publish our documentation, and delegate the subdomain `docs.dolthub.com` to `dolt.gitbook.io`. GitBook operates by syncing the contents of this repository. The GitBook/GitHub integration is documented [here](https://docs.gitbook.com).
We use [GitBook](https://www.gitbook.com/) to publish our documentation, and delegate the subdomain `docs.[product].com` to `dolt.gitbook.io`. GitBook operates by syncing the contents of this repository. The GitBook/GitHub integration is documented [here](https://docs.gitbook.com).

Using GitBook requires us to adopt their model of content structuring in order to properly render our markdown. The restrictions are as follows:

Expand All @@ -18,7 +22,7 @@ Using GitBook requires us to adopt their model of content structuring in order t

## Contribution Workflow

We have two GitBook "spaces", one for development and review, and one for production:
We have two GitBook "spaces" for each product, one for development and review, and one for production:

- "Dolt", which [docs.dolthub.com](https://docs.dolthub.com/) links to, and syncs off of `gitbook-publish`
- "Dolt Dev", which is [dolt.gitbook.io/dolt-dev](https://dolt.gitbook.io/dolt-dev/), and syncs off of `gitbook-dev`
Expand All @@ -39,21 +43,34 @@ To recap:
The following diagram illustrates the workflow:
![GitHub/GitBook Workflow](gitbook_workflow.png)

### All spaces

- [Dolt](https://docs.dolthub.com)
- [Dolt Dev](https://dolt.gitbook.io/dolt-dev/)
- [Doltgres](https://docs.doltgres.com)
- [Doltgres Dev](https://dolt.gitbook.io/doltgres-dev/)
- [DoltLab](https://docs.doltlab.com)
- [DoltLab Dev](https://dolt.gitbook.io/doltlab-dev/)

## Check Dead Links

This [tool](https://www.deadlinkchecker.com/) is free and works quite well if you just pass the dev URL, `https://dolt.gitbook.io/dolt-dev/`, into it.

## Styling Tips

You can create a styled info box for a note callout by including the following:

```
{% hint style="info" %}
### Note
My styled note!
My styled note!
{% endhint %}
```

## Embed DoltHub SQL Console

You can embed DoltHub SQL console by including the following:

```
{% embed url="https://www.dolthub.com/repositories/[owner]/[database]/embed/[refName]?q={query}" %}
```
Expand Down
10 changes: 8 additions & 2 deletions packages/dolt/.gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,11 @@ redirects:
guides/dolthub-api/database: products/dolthub/dolthub-api/database.md
guides/dolthub-api/sql: products/dolthub/dolthub-api/sql.md
guides/doltlab/: products/doltlab/README.md
guides/doltlab/installation: products/doltlab/installation.md
guides/doltlab/administrator: products/doltlab/administrator.md
guides/doltlab/installation: products/doltlab/README.md
guides/doltlab/administrator: products/doltlab/README.md
products/doltlab/installation: products/doltlab/README.md
products/doltlab/administrator: products/doltlab/README.md
products/doltlab/api: products/doltlab/README.md
products/doltgres/installation: products/doltgres/README.md
products/doltgres/replication-from-postgres: products/doltgres/README.md
products/doltgres/running-server: products/doltgres/README.md
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
8 changes: 1 addition & 7 deletions packages/dolt/content/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
- [Manual Data Curation](introduction/use-cases/manual-data-curation.md)
- [Version Control for your Application](introduction/use-cases/vc-your-app.md)
- [Versioned MySQL Replica](introduction/use-cases/versioned-replica.md)
- [Audit](introduction/use-cases/audit.md)
- [Audit](introduction/use-cases/audit.md)
- [Configuration Management](introduction/use-cases/configuration-management.md)
- [Offline First](introduction/use-cases/offline-first.md)

Expand Down Expand Up @@ -121,13 +121,7 @@
- [Transform File Uploads](products/dolthub/transform-uploads.md)
- [Workspaces](products/dolthub/workspaces.md)
- [DoltLab](products/doltlab/README.md)
- [Install DoltLab](products/doltlab/installation.md)
- [Administrator Guide](products/doltlab/administrator.md)
- [API](products/doltlab/api.md)
- [DoltgreSQL](products/doltgres/README.md)
- [Install DoltgreSQL](products/doltgres/installation.md)
- [Running the Server](products/doltgres/running-server.md)
- [Replication from Postgres](products/doltgres/replication-from-postgres.md)

## Architecture

Expand Down
2 changes: 1 addition & 1 deletion packages/dolt/content/concepts/dolthub.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ DoltHub wants to change the way data is shared and collaborated on, similar to h

DoltLab is the self-hosted version of DoltHub that allows you to run your own DoltHub on-prem. If you're interested in using Dolt in production at your company, but can't push data to DoltHub, DoltLab is the product you're looking for. DoltLab provides the same web-based UI as DoltHub, backed entirely by local disk, so your data never leaves your control!

Released as a simple zip file, DoltLab is a suite of publically available container images that run using Docker Compose on a single Linux host. This host can be a local desktop, or a cloud server, but by no means are any cloud resources required to start running DoltLab today.
Released as a simple zip file, DoltLab is a suite of publicly available container images that run using Docker Compose on a single Linux host. This host can be a local desktop, or a cloud server, but by no means are any cloud resources required to start running DoltLab today.
42 changes: 1 addition & 41 deletions packages/dolt/content/products/doltgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,4 @@ many gaps that need to be addressed before being used in production.
Download the latest DoltgreSQL
[here](https://github.com/dolthub/doltgresql/releases/latest).

For instructions on how to install and run DoltgreSQL, checkout our [installation
guide](./installation.md).

## Differences from Dolt

For the most part, you can refer to the [documentation for the Dolt SQL
server](../../reference/sql/server/README.md) to understand how to run and use DoltgreSQL and its
features. Just connect with a Postgres-compatible client instead of a MySQL-compatible client.

Places where the two products differ in their operation are detailed in this section of the docs.

Unlike Dolt, DoltgreSQL does not implement version control features via the command line and must be
run as a server. For example, the Dolt CLI command to pull from a remote:

```
% dolt pull
```

Can only be accessed in DoltgreSQL through its corresponding [SQL stored
procedure](../../reference/sql/version-control/dolt-sql-procedures.md):

```bash
% doltgres &
% psql -h 127.0.0.1 -U doltgres -c "CALL DOLT_PULL()"
```

Refer to the docs for [version control features](../../reference/sql/version-control/README.md) for
details on supported stored procedures and system tables.

## Doltgres is pre-alpha

Doltgres is still in very active development and many required features are missing. Check back
often for progress. You can also follow our [blog](https://www.dolthub.com/blog/) for updates, where
we publish DoltgreSQL blogs every few weeks.

Here are some of the DoltgreSQL blogs we've published so far:

- [Announcing DoltgreSQL](https://www.dolthub.com/blog/2023-11-01-announcing-doltgresql/)
- [Adding Types to DoltgreSQL](https://www.dolthub.com/blog/2024-02-14-adding-types-to-doltgresql/)
- [Writing a Postgres Logical Replication System in
Golang](https://www.dolthub.com/blog/2024-03-08-postgres-logical-replication/)
## For DoltgreSQL documentation visit the [Doltgres docs site](https://docs.doltgres.com).
13 changes: 0 additions & 13 deletions packages/dolt/content/products/doltgres/installation.md

This file was deleted.

110 changes: 0 additions & 110 deletions packages/dolt/content/products/doltgres/replication-from-postgres.md

This file was deleted.

69 changes: 0 additions & 69 deletions packages/dolt/content/products/doltgres/running-server.md

This file was deleted.

11 changes: 1 addition & 10 deletions packages/dolt/content/products/doltlab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,4 @@ Download the latest DoltLab [here](https://doltlab-releases.s3.amazonaws.com/lin

[DoltLab](https://www.doltlab.com) is the self-hosted version of [DoltHub](https://www.dolthub.com) that allows you to deploy and manage your own DoltHub instance on-prem. DoltLab has the same user interface and features as DoltHub so consult the [DoltHub Documentation](../dolthub/README.md) for general questions. This DoltLab documentation focuses on installation and administration.

For instructions on how to install the latest DoltLab version, checkout our [installation guide](./installation.md). After installing, learn how to operate DoltLab like a pro by reading our [administrator guide](./administrator.md).

You can also get more DoltLab content by checking out our [blog](https://www.dolthub.com/blog/), where we've published the following articles about DoltLab:

- [Announcing DoltLab: Your Self-Hosted DoltHub Solution](https://www.dolthub.com/blog/2022-01-14-announcing-doltlab/)
- [Getting Started with DoltLab Video](https://www.dolthub.com/blog/2022-02-22-getting-started-doltlab-video/)
- [DoltLab 101: Services Overview and 2022 Roadmap](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/)
- [Deploying a Production Ready DoltLab Instance: An example](https://www.dolthub.com/blog/2022-03-16-deploying-a-production-ready-doltlab-instance/)
- [Monitoring a DoltLab instance with Prometheus](https://www.dolthub.com/blog/2022-05-09-monitoring-doltlab-with-prometheus/)
- [Is DoltLab right for you?](https://www.dolthub.com/blog/2022-05-25-is-doltlab-right-for-you/)
## For DoltLab documentation visit the new [DoltLab docs site](https://docs.doltlab.com).
Loading

0 comments on commit 92cb30e

Please sign in to comment.