docs's People
Forkers
adlerfaulkner yogevkr 0xflotus oleks bpf120 ericturner3 datasoar andthewings aboodman ypid samherrmann isabella232 tsonglew pbowyer theetrain muescha funnell myers kelley12 hanifanazka xxsonicghostxxdocs's Issues
New Doc: Installation/Upgrading
We should have a section in Installation about upgrading. Mostly just re-run the install script.
Collations/Charsets in Features needs updating
https://docs.dolthub.com/sql-reference/sql-support/miscellaneous#collations-and-character-sets
This should be a table of the charsets and collations we support/don not support
Add documentation for procedure `dolt_verify_constraints`
New Doc: Saved Queries
In SQL Reference section.
Use this as a template
https://www.dolthub.com/blog/2020-02-28-announcing-saved-queries/
Update old dolthub screenshots
Pages:
- https://docs.dolthub.com/introduction/quickstart
- https://docs.dolthub.com/getting-started/dolthub (data publishing / using dolthub is done)
- https://docs.dolthub.com/getting-started/bounties
Document join hints
We support Oracle style join order hints.
SELECT /*+ JOIN_ORDER(pa, p, ib, obj, o, ik, ki) */ count(*) ...
These should be documented.
Need Compatibility Doc
Not the specific reference doc. Just the SQL Logic tests what they are, how they work, and our number like the performance page. Updated with every release. Link to SQL reference at the end.
System Variables documentation is a bit lacking
Maybe need a high level doc here:
https://docs.dolthub.com/concepts/dolt/sql
and/or buff out this document a bit:
https://docs.dolthub.com/sql-reference/version-control/dolt-sysvars
New Doc: Recommended SQL Workbench
We should have a recommended SQL workbench with a detailed example of how to connect it and use it to do dolt stuff like diff and merge.
This accomplishes two goals:
- Help out new folks
- Show we're a real database like MySQL or Postgres
How to connect to external PostgreSQL with DoltLab
Add DoltLab to Concepts/Dolt/Remotes
Conspicuously missing.
Bad highlighting behavior for code blocks
https://docs.dolthub.com/introduction/getting-started/database#create-a-table
If you highlight that code snipped and copy (as opposed to clicking on the copy button, which works) and then paste, the result is either:
For me:
use dolts;
2
create table employees (
3
last_name varchar(255),
4
first_name varchar(255),
5
title varchar(255),
6
date_started date,
7
primary key(last_name, first_name)
8
);
For spacelove:
use dolts;
It should just copy the code itself:
use dolts;
create table employees (
last_name varchar(255),
first_name varchar(255),
title varchar(255),
date_started date,
primary key(last_name, first_name)
);
CLI reference doesn't list all `dolt` subcommands
I'm writing tldr pages for all of the dolt
commands, and when we write tldr pages we like to like to the home page/man page of the specific command we're documenting, so that users can learn more about the command from official sources of documentation.
Each subcommand gets its own page and therefore gets its own link. I'd like to link to the subcommand's entry on https://docs.dolthub.com/interfaces/cli, e.g. dolt add
would have https://docs.dolthub.com/interfaces/cli#dolt-add as a link, but I can't do that very easily because only 21 of the total 32 subcommands are listed there.
Currently, the only dolt
subcommands missing from https://docs.dolthub.com/interfaces/cli are:
conflicts
creds
filter-branch
gc
migrate
read-tables
schema
table
tag
verify-constraints
version
The commands themselves have --help
options which display help information, so it looks like a simple copy and paste from there to the docs page would do the trick. Is it not that simple?
More SQL Examples in Concepts section
The Concepts section is heavy on command line and light on SQL examples. This is because I don't know the SQL versions of these commands very well. @VinaiRachakonda should take a pass.
Need FAQ.
Start with Zach's FAQ. I think it might go well in "Getting Started" or "Reference"
Audit SQL Editors Doc
Please audit.
https://docs.dolthub.com/reference/sql/supported/sql-editors
This is not true anymore:
NOTE: Dolt does not support SSL yet, so be sure to turn it off on your editor before connecting.
Add reference docs for `dolt_commits` system table
The dolt_commits
system table needs to be added to the system table reference docs.
New Doc: Importing Data guide
We should have a detailed document on how to get data into Dolt from the following sources:
- MySQL
- Postgres
- CSVs
Troubleshooting Guide
Some ideas to cover:
- turn on loglevel trace or debug
- explain
dolt gc
- what does mysql do?
Dolt Use Cases document
We have a couple of blog posts that detail how to use Dolt:
- https://www.dolthub.com/blog/2021-03-09-dolt-use-cases-in-the-wild/
- https://www.dolthub.com/blog/2020-03-30-dolt-use-cases/
We want to cover the following users:
- individuals
- teams (Dolt + DoltHub)
- enterprises (Dolt with support)
Turn contributing Blogs into Guides/Contributing
We should formalize the two contributing Blogs:
- https://www.dolthub.com/blog/2021-12-06-contributing-to-dolt/
- https://www.dolthub.com/blog/2021-09-08-how-to-contribute-to-dolt/
Into their own Guides/Contributing/Dolt and Guides/Contributing/Go MySQL Server docs.
Add return apis for DOLT Stored Procedure
For each stored procedure we should document what exactly is being returned. This is useful for applications that are programmatically calling said procedures.
New Doc: SQL Reference/Version Control Features/Merge
- How conflicts are calculated
- data
- schema
- The
dolt_conflicts
anddolt_conflicts_<tablename>
tables- Schema conflicts are not resolvable via SQL
- Resolving conflicts in SQL
- Note must resolve in a single transaction
- Persisting conflicts to resolve later (not default)
Convert snippets to asciinema versions
Add "Why do inserts get slower as my database gets larger?" FAQ Item
This behavior confuses people.
There are two possible reasons:
- Depth of tree (small)
- Mega chunks (large)
We need to explain this.
New Section: In Guides, we need Sample Databases
Start from scratch and build a few canonical databases of different types:
- Computer vision
- Text from multiple customers
- Genomes
Typo Error : Crate instead Create
New Doc: Need to explain Dolt column Tags
Mysterious.
Update Create Database
React widget for rendering data in docs
Add Download Latest DoltLab Header to DoltLab Guide Section
At the the top of the DoltLab guide section (and maybe at the top of all sections) add a Header with link for downloading the latest DoltLab.
`dolt_query_catalog` in `sql/reference/dolt-system-tables`
The saved query system table is not documented along with the other Dolt System Tables.
Add multi db dir to Docker Dolt SQL Server example
Broken images on TablePlus how to.
Refresh Data Import Guide
The Importing Data Guide could use a quick refresh.
The import best practices sections is hidden at the bottom of the page, making it difficult for customers to find and it could also use some more detail (e.g. explain how to turn off foreign key checks, explain how to use dolt verify constraints after turning them back on). Some of the recent import perf enhancements might have some updates in the doc, too (e.g. do we still need to recommending minimizing blob usage now that their import perf is much more reasonable?).
Putting linkable navigation by use case (e.g. importing a MySQL dump) up at the top would help, too (we have some use cases bulleted, but not linked, so makes navigating the doc harder).
Add TPCC and other transactional benchmarking data to Reference/SQL/Performance
https://docs.dolthub.com/reference/sql/latency
This could use more of the transactional data.
New Doc: Guides/DoltLab
This is a start. We may need to restructure the overall docs to include DoltLab but this is a Good start.
Write Reference: Remotes
We need a remotes doc that explains DoltHub, S3, GCS, and Filesystem remotes. It should also explain that we do not have HTTP or SSH remotes like Git.
Typo on Authentication page
https://docs.dolthub.com/products/dolthub/dolthub-api/authentication
The line
"https://www.dolthub.com/api/v1alpha1/{}/{}".format(owner, repo, branch),
should be
"https://www.dolthub.com/api/v1alpha1/{}/{}/{}".format(owner, repo, branch),
or equivalently
f"https://www.dolthub.com/api/v1alpha1/{owner}/{repo}/{branch}"
Transaction Support Means a Rewrite of Concurrency Docs
Dolt CLI right nav need some love
We need to address:
- Command ordering. Should either be alphabetical or match the CLI.
- Get rid of the subsections. Only the commands should be listed.
Windows Link 404s on Quickstart Page
The Windows doc link is broken on this page (404 on Github). https://docs.dolthub.com/introduction/quickstart. The broken link is at For windows installation, see here
.
More diagrams/pictures in Dolt concepts section
These sections are informative but rather dry without pictures.
Concepts/SQL section
We have a Dolt and DoltHub concepts section but it may be useful to also have a SQl Concepts section where we describe things like transactions, column tags, users/grants, collations, etc. What these are and how they are the same/different in Dolt than other SQL databases like MySQL or Postgres.
New Doc: High Availability
We need a document on our (not yet) high availability story and our plan to have one.
New Doc: SQL Reference/Running the Server/Debugging
We need a doc on debugging a running serevr when it gets slow, is crashing, or returning bad results.
Topics could include:
- Is it under memory pressure? Does restarting help?
--loglevel=trace
. Figuring out which queries are slow.- Are you CPU pegged?
- Adding read replicas.
- Garbage collection
Need SQL Reference/Version Control Features/Using Remotes
Architecture section needs some love.
Add "Hardware Recommendation" to Installation/Application Server
I think we need to give some guidance on how big a box people will need.
New Doc: Resource Requirements
We need a serious examination on what kind of CPU, Memory, and disk we recommend for similar sized Postgres/MySQL databases migrating to Dolt. This will take some work/research.
We do know you need about 1% of the database size in memory. We also know Dolt makes dramatically more disk garbage than other databases. We should try and quantify this.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.