mirror of https://github.com/datahub-project/datahub.git synced 2025-07-24 10:00:07 +00:00

History

build(docs-website): only show release notes for recent releases (#5621 )

* build(docs-website): only show release notes for recent releases

Bonus: also hides the release candidates from the docs website and
tweaks our date formatting to look better.

Changes stacked on top of
https://github.com/datahub-project/datahub/pull/5620, so merge that
first.

* lint

2022-08-11 14:51:09 -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

genJsonSchema

feat(docs): Updating example files with the new ingestion recipe suffix (#5103 )

2022-06-07 15:52:26 -07:00

graphql

docs(graphql): adding additional GraphQL docs (#3649 )

2021-12-01 11:17:31 -08:00

src

docs(adopter): add Digital Turbine as DataHub adopter (#5290 )

2022-06-29 10:47:51 -07:00

static

docs(adopter): add Digital Turbine as DataHub adopter (#5290 )

2022-06-29 10:47:51 -07:00

.gitignore

feat(doc): Generating json schema for ingestion recipes (#5092 )

2022-06-06 09:31:44 +02:00

babel.config.js

docs: hosted documentation website (#2174 )

2021-03-05 00:12:12 -08:00

build.gradle

chore(gradle): update node version for docs site (#5581 )

2022-08-05 16:03:57 -07:00

docusaurus.config.js

docs(reindex): fix docsearch config (#5479 )

2022-07-25 15:08:28 -07:00

generateDocsDir.ts

build(docs-website): only show release notes for recent releases (#5621 )

2022-08-11 14:51:09 -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

feat(apache-ranger): Apache Ranger Authorizer support in datahub-gms (#4999 )

2022-08-01 09:47:08 -07:00

yarn.lock

build(deps): bump terser from 5.9.0 to 5.14.2 in /docs-website (#5448 )

2022-07-21 08:54:51 -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