Coder Social home page Coder Social logo

docs's Introduction

title
Dolt Documentation

Introduction

This repository contains Dolt and DoltHub documentation.

GitBook Hosting

We use GitBook 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.

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

  • the root directory is set in .gitbook.yaml
  • assets, i.e. images, need to live in content/.gitbook/assets
  • the content structure is configured in content/SUMMARY.md

Contribution Workflow

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

To make a contribution create a feature branch, either in a fork or in this repository, and then make a PR against gitbook-dev. This can be reviewed and merged, which will result in it being deployed to "Dolt Dev" space. Once it has been reviewed in GitBook we can merge gitbook-dev to gitbook-publish, and it will land in production.

To add a new page to the docs, make sure you update SUMMARY.md

To update Dolt CLI reference docs, make updates to the Dolt command code in the dolt repo, then run dolt dump-docs to regenerate the CLI markdown file and copy it to content/reference/cli.md.

To recap:

  • make changes on your-feature-branch
  • if adding a new page, update SUMMARY.md
  • review and merge to gitbook-dev, gitbook-dev syncs to Dolt Dev
  • once you are satisfied with your changes, merge gitbook-dev to gitbook-publish, at which point your changes will sync'd to production

The following diagram illustrates the workflow: GitHub/GitBook Workflow

Check Dead Links

This tool is free and works quite well if you just pass the dev URL, https://dolt.gitbook.io/dolt-dev/, into it.

docs's People

Contributors

0xflotus avatar aboodman avatar andthewings avatar andy-wm-arthur avatar binokkio avatar bpf120 avatar coffeegoddd avatar datasoar avatar ericturner3 avatar fulghum avatar hydrocharged avatar jennifersp avatar jhult avatar jycor avatar liuliu-dev avatar max-hoffman avatar oleks avatar pbowyer avatar petros avatar reltuk avatar samherrmann avatar stephkyou avatar tbantle22 avatar timsehn avatar tsonglew avatar vinairachakonda avatar yogevkr avatar zachmu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.