datahub/docs-website
Aseem Bansal 7fcc71ed81
fix(docs): make intro to metadata ingestion easier for beginners (#4039)
* fix(docs): fix sidebar titles for clarity

* re-arrange docs to make Intro to Metadata ingestion easier for beginners

* minor changes for readability

* add heading

* docs: add note for common question
2022-02-11 09:03:01 -08:00
..

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn run lint
yarn run generate
yarn run start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Generating GraphQL API Docs

To regenerate GraphQL API docs, simplym rebuild the docs-website directory.

./gradlew docs-website:build