yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-06-27 05:03:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
datahub/docs-website
History
John Joyce d6239f8203
docs(actions): Adding DataHub Actions to docs website (#5054)
2022-05-31 19:01:44 -07:00
..
docs
refactor(graphql): GraphQL Public API Refactor + Documentation (#3278)
2021-09-22 17:30:15 -07:00
genDocs
refactor(graphql): GraphQL Public API Refactor + Documentation (#3278)
2021-09-22 17:30:15 -07:00
graphql
docs(graphql): adding additional GraphQL docs (#3649)
2021-12-01 11:17:31 -08:00
src
docs(website): Remove banner and nav item for metadata day 2022 (#4968)
2022-05-20 20:23:55 +05:30
static
docs: add sumup logo (#4549)
2022-04-01 11:21:59 -07:00
.gitignore
refactor(graphql): GraphQL Public API Refactor + Documentation (#3278)
2021-09-22 17:30:15 -07:00
babel.config.js
docs: hosted documentation website (#2174)
2021-03-05 00:12:12 -08:00
build.gradle
feat(ingest): docs - overhaul source connector docs to make it code driven (#4798)
2022-05-02 00:18:15 -07:00
docusaurus.config.js
docs(website): Remove banner and nav item for metadata day 2022 (#4968)
2022-05-20 20:23:55 +05:30
generateDocsDir.ts
docs(actions): Adding DataHub Actions to docs website (#5054)
2022-05-31 19:01:44 -07:00
package.json
chore(docs): various cleanup for docs-website (#4143)
2022-02-17 12:15:39 -08:00
README.md
refactor(graphql): GraphQL Public API Refactor + Documentation (#3278)
2021-09-22 17:30:15 -07:00
sidebars.js
docs(actions): Adding DataHub Actions to docs website (#5054)
2022-05-31 19:01:44 -07:00
yarn.lock
chore(deps): bump async from 2.6.3 to 2.6.4 in /docs-website (#4846)
2022-05-06 09:51:12 -07:00

README.md

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