2022-08-26 16:29:01 -05:00
require ( "dotenv" ) . config ( ) ;
const isSaas = process . env . DOCUSAURUS _IS _SAAS === "true" ;
2021-03-05 00:12:12 -08:00
module . exports = {
2022-08-26 16:29:01 -05:00
title : process . env . DOCUSAURUS _CONFIG _TITLE || "DataHub" ,
2024-09-18 13:51:44 -04:00
tagline : "The #1 Open Source Metadata Platform" ,
2022-08-26 16:29:01 -05:00
url : process . env . DOCUSAURUS _CONFIG _URL || "https://datahubproject.io" ,
baseUrl : process . env . DOCUSAURUS _CONFIG _BASE _URL || "/" ,
2021-03-05 00:12:12 -08:00
onBrokenLinks : "throw" ,
onBrokenMarkdownLinks : "throw" ,
favicon : "img/favicon.ico" ,
2022-07-25 22:08:28 +00:00
organizationName : "datahub-project" , // Usually your GitHub org/user name.
2021-03-05 00:12:12 -08:00
projectName : "datahub" , // Usually your repo name.
2025-02-22 16:54:59 -08:00
staticDirectories : [ "static" ] ,
2023-09-26 14:26:06 -05:00
stylesheets : [ "https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;700&display=swap" ] ,
2025-01-13 13:38:04 -06:00
headTags : [
{
tagName : 'meta' ,
attributes : {
httpEquiv : 'Content-Security-Policy' ,
content : "frame-ancestors 'self' https://*.acryl.io https://acryldata.io http://localhost:*"
}
} ,
] ,
2023-10-25 09:39:57 +09:00
scripts : [
{
src : "https://tools.luckyorange.com/core/lo.js?site-id=28ea8a38" ,
async : true ,
defer : true ,
} ,
2024-07-08 16:12:30 -07:00
{
src : "/scripts/rb2b.js" ,
async : true ,
defer : true ,
2024-09-11 07:07:56 +09:00
} ,
{
src : "https://app.revenuehero.io/scheduler.min.js"
2025-03-13 16:26:15 -05:00
} ,
{
src : "https://tag.clearbitscripts.com/v1/pk_2e321cabe30432a5c44c0424781aa35f/tags.js" ,
referrerPolicy : "strict-origin-when-cross-origin"
2025-03-21 12:59:57 -05:00
} ,
{
src : "/scripts/reo.js" ,
2024-07-08 16:12:30 -07:00
}
2023-10-25 09:39:57 +09:00
] ,
2022-08-26 16:29:01 -05:00
noIndex : isSaas ,
customFields : {
isSaas : isSaas ,
2024-03-28 12:10:03 +09:00
markpromptProjectKey : process . env . DOCUSAURUS _MARKPROMPT _PROJECT _KEY || "0U6baUoEdHVV4fyPpr5pxcX3dFlAMEu9" ,
2022-08-26 16:29:01 -05:00
} ,
2024-03-11 15:06:39 -07:00
// See https://github.com/facebook/docusaurus/issues/4765
// and https://github.com/langchain-ai/langchainjs/pull/1568
webpack : {
jsLoader : ( isServer ) => ( {
loader : require . resolve ( "swc-loader" ) ,
options : {
jsc : {
parser : {
syntax : "typescript" ,
tsx : true ,
} ,
target : "es2017" ,
} ,
module : {
type : isServer ? "commonjs" : "es6" ,
} ,
} ,
} ) ,
} ,
2021-03-05 00:12:12 -08:00
themeConfig : {
2024-09-18 13:51:44 -04:00
// ...(!isSaas && {
// announcementBar: {
// id: "announcement",
// content:
// '<div><img src="/img/acryl-logo-white-mark.svg" /><p><strong>DataHub Cloud</strong><span> Acryl Data delivers an easy to consume DataHub platform for the enterprise</span></p></div> <a href="https://www.acryldata.io/datahub-sign-up?utm_source=datahub&utm_medium=referral&utm_campaign=acryl_signup" target="_blank" class="button button--primary">Sign Up for DataHub Cloud →</a>',
// backgroundColor: "#070707",
// textColor: "#ffffff",
// isCloseable: false,
// },
// }),
2024-10-15 10:55:23 -04:00
announcementBar : {
2024-11-04 17:39:54 -05:00
id : "announcement-3" ,
2024-10-15 10:55:23 -04:00
content :
2025-02-05 14:20:44 -05:00
'<div style="display: flex; justify-content: center; align-items: center;width: 100%;"><!--img src="/img/acryl-logo-white-mark.svg" / --><!--div style="font-size: .8rem; font-weight: 600; background-color: white; color: #111; padding: 0px 8px; border-radius: 4px; margin-right:12px;">NEW</div--><p>Learn about DataHub 1.0</p><a href="https://youtu.be/B3IA6cLaKEk" target="_blank" class="button">Watch Now<span> →</span></a></div>' ,
2024-10-15 10:55:23 -04:00
backgroundColor : "#111" ,
textColor : "#ffffff" ,
isCloseable : false ,
} ,
2024-09-24 18:24:08 -07:00
colorMode : {
// Only support light mode.
defaultMode : 'light' ,
disableSwitch : true ,
respectPrefersColorScheme : false ,
} ,
2021-03-05 00:12:12 -08:00
navbar : {
2021-10-21 15:49:44 -05:00
title : null ,
2021-03-05 00:12:12 -08:00
logo : {
alt : "DataHub Logo" ,
2023-09-26 14:26:06 -05:00
src : ` img/ ${ isSaas ? "acryl" : "datahub" } -logo-color-light-horizontal.svg ` ,
srcDark : ` img/ ${ isSaas ? "acryl" : "datahub" } -logo-color-dark-horizontal.svg ` ,
2021-03-05 00:12:12 -08:00
} ,
items : [
2024-09-27 16:17:51 +05:30
{
2024-10-30 04:56:12 +09:00
type : "dropdown" ,
label : "Solutions" ,
position : "right" ,
items : [
{
to : "/solutions/discovery" ,
label : "Discovery" ,
} ,
{
to : "/solutions/observability" ,
label : "Observability" ,
} ,
{
to : "/solutions/governance" ,
label : "Governance" ,
} ,
]
} ,
{
to : "/cloud" ,
2024-09-27 16:17:51 +05:30
activeBasePath : "cloud" ,
label : "Cloud" ,
position : "right" ,
} ,
2021-03-05 00:12:12 -08:00
{
2024-04-17 17:54:44 +09:00
to : "docs/" ,
2021-03-05 00:12:12 -08:00
activeBasePath : "docs" ,
label : "Docs" ,
position : "right" ,
} ,
2024-07-31 09:13:16 +09:00
{
2024-09-27 14:54:05 +09:00
to : "/integrations" ,
activeBasePath : "integrations" ,
label : "Integrations" ,
2024-07-31 09:13:16 +09:00
position : "right" ,
} ,
2024-07-19 07:59:22 +09:00
{
2024-09-27 14:54:05 +09:00
type : "dropdown" ,
2024-07-19 07:59:22 +09:00
activeBasePath : "learn" ,
label : "Learn" ,
position : "right" ,
2024-09-27 14:54:05 +09:00
items : [
2024-10-07 16:46:53 -04:00
{
to : "https://www.acryldata.io/webinars/weekly-live-demo" ,
label : "Weekly Demo" ,
} ,
2024-09-27 14:54:05 +09:00
{
to : "/learn" ,
label : "Use Cases" ,
} ,
{
to : "/adoption-stories" ,
label : "Adoption Stories" ,
} ,
{
2025-03-14 17:45:47 -07:00
href : "https://medium.com/datahub-project" ,
2024-09-27 14:54:05 +09:00
label : "Blog" ,
} ,
{
href : "https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" ,
label : "YouTube" ,
} ,
] ,
2023-03-13 11:37:24 -07:00
} ,
2024-01-17 05:55:02 +09:00
{
type : "dropdown" ,
label : "Community" ,
position : "right" ,
items : [
{
2025-02-26 11:17:31 -08:00
href : "https://pages.acryl.io/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" ,
2024-01-16 18:37:25 -05:00
label : "Join Slack" ,
} ,
2024-04-08 12:37:34 +09:00
{
href : "https://forum.datahubproject.io/" ,
label : "Community Forum" ,
} ,
2024-01-16 18:37:25 -05:00
{
2024-02-10 04:43:40 +09:00
to : "/events" ,
2024-01-16 18:37:25 -05:00
label : "Events" ,
2024-01-17 05:55:02 +09:00
} ,
{
to : "/champions" ,
label : "Champions" ,
} ,
2024-06-17 12:54:34 +09:00
{
label : "Share Your Journey" ,
href : "/customer-stories-survey" ,
} ,
2024-01-17 05:55:02 +09:00
] ,
} ,
2021-03-05 00:12:12 -08:00
{
2025-02-26 11:17:31 -08:00
href : "https://pages.acryl.io/slack?utm_source=docs&utm_medium=header&utm_campaign=docs_header" ,
2024-09-27 14:54:05 +09:00
html : `
< style >
. slack - logo : hover {
opacity : 0.8 ;
}
< / s t y l e >
< img class = 'slack-logo' src = 'https://upload.wikimedia.org/wikipedia/commons/d/d5/Slack_icon_2019.svg' , alt = 'slack' , height = '20px' style = 'margin: 10px 0 0 0;' / >
` ,
2021-11-17 18:51:56 -06:00
position : "right" ,
} ,
2023-08-26 06:10:13 +09:00
{
2024-09-27 14:54:05 +09:00
href : "/cloud" ,
html : `
< style >
. cloud - cta : hover {
opacity : 0.8 ;
}
< / s t y l e >
2024-10-28 19:14:10 -04:00
< div class = 'cloud-cta button button--primary' alt = 'try-datahub-cloud' style = 'font-weight: 700;' > Get DataHub Cloud < / d i v >
2024-09-27 14:54:05 +09:00
` ,
position : "right" ,
}
2021-03-05 00:12:12 -08:00
] ,
} ,
footer : {
style : "dark" ,
links : [
{
title : "Docs" ,
items : [
{
label : "Introduction" ,
to : "docs/" ,
} ,
{
label : "Quickstart" ,
to : "docs/quickstart" ,
} ,
] ,
} ,
{
title : "Community" ,
items : [
{
label : "Slack" ,
2021-03-31 12:29:01 -07:00
href : "https://slack.datahubproject.io" ,
2021-03-05 00:12:12 -08:00
} ,
{
label : "YouTube" ,
href : "https://www.youtube.com/channel/UC3qFQC5IiwR5fvWEqi_tJ5w" ,
} ,
2021-11-17 18:51:56 -06:00
{
label : "Blog" ,
2025-03-14 17:45:47 -07:00
href : "https://medium.com/datahub-project" ,
2021-11-17 18:51:56 -06:00
} ,
2021-03-05 00:12:12 -08:00
{
label : "Town Halls" ,
to : "docs/townhalls" ,
} ,
{
label : "Adoption" ,
2024-09-24 18:24:08 -07:00
href : "/adoption-stories" ,
2021-03-05 00:12:12 -08:00
} ,
] ,
} ,
{
title : "More" ,
items : [
{
label : "Demo" ,
2023-04-06 10:40:20 +09:00
to : "https://demo.datahubproject.io/" ,
2021-03-05 00:12:12 -08:00
} ,
{
label : "Roadmap" ,
2022-01-17 16:23:25 -06:00
href : "https://feature-requests.datahubproject.io/roadmap" ,
2021-03-05 00:12:12 -08:00
} ,
{
label : "Contributing" ,
to : "docs/contributing" ,
} ,
{
label : "GitHub" ,
2022-03-18 22:12:19 +01:00
href : "https://github.com/datahub-project/datahub" ,
2021-03-05 00:12:12 -08:00
} ,
2021-11-17 18:51:56 -06:00
{
label : "Feature Requests" ,
href : "https://feature-requests.datahubproject.io/" ,
} ,
2021-03-05 00:12:12 -08:00
] ,
} ,
] ,
copyright : ` Copyright © 2015- ${ new Date ( ) . getFullYear ( ) } DataHub Project Authors. ` ,
} ,
2021-05-11 15:16:12 -07:00
prism : {
2022-12-06 19:13:28 -05:00
// https://docusaurus.io/docs/markdown-features/code-blocks#theming
// theme: require("prism-react-renderer/themes/vsLight"),
// darkTheme: require("prism-react-renderer/themes/vsDark"),
additionalLanguages : [ "ini" , "java" , "graphql" , "shell-session" ] ,
2021-05-11 15:16:12 -07:00
} ,
2025-03-10 13:23:30 -07:00
algolia : {
// This is the "Search API Key" in Algolia, which means that it is ok to be public.
apiKey : "2adf840a044a5ecbf7bdaac88cbf9ee5" ,
appId : "RK0UG797F3" ,
indexName : "datahubproject" ,
insights : true ,
contextualSearch : true ,
// debug: true,
} ,
2021-03-05 00:12:12 -08:00
} ,
presets : [
[
"@docusaurus/preset-classic" ,
{
docs : {
2024-04-19 15:12:32 +09:00
lastVersion : "current" ,
versions : {
current : {
label : "Next" ,
banner : 'none' ,
} ,
} ,
2021-03-05 00:12:12 -08:00
path : "genDocs" ,
sidebarPath : require . resolve ( "./sidebars.js" ) ,
2022-08-26 16:29:01 -05:00
... ( ! isSaas && {
editUrl : "https://github.com/datahub-project/datahub/blob/master/" ,
} ) ,
2022-02-17 15:15:39 -05:00
numberPrefixParser : false ,
2021-03-05 00:12:12 -08:00
// TODO: make these work correctly with the doc generation
2024-03-05 16:28:03 -08:00
showLastUpdateAuthor : false ,
showLastUpdateTime : false ,
2021-03-05 00:12:12 -08:00
} ,
2024-07-19 07:59:22 +09:00
blog : {
blogTitle : "DataHub Learn" ,
blogSidebarTitle : "DataHub Learn" ,
blogDescription : "Learn about the hot topics in the data ecosystem and how DataHub can help you with your data journey." ,
path : "src/learn" ,
routeBasePath : "learn" ,
postsPerPage : "ALL" ,
blogListComponent : "../src/learn/_components/LearnListPage" ,
} ,
2021-03-05 00:12:12 -08:00
theme : {
2022-08-26 16:29:01 -05:00
customCss : [
2023-09-26 14:26:06 -05:00
isSaas ? require . resolve ( "./src/styles/acryl.scss" ) : require . resolve ( "./src/styles/datahub.scss" ) ,
2022-08-26 16:29:01 -05:00
require . resolve ( "./src/styles/global.scss" ) ,
2023-04-07 13:28:31 -05:00
require . resolve ( "./src/styles/sphinx.scss" ) ,
2023-04-04 18:40:19 +05:30
require . resolve ( "./src/styles/config-table.scss" ) ,
2024-09-27 14:54:05 +09:00
require . resolve ( "./src/components/SecondNavbar/styles.module.scss" ) ,
2025-01-16 01:11:55 +09:00
require . resolve ( "./src/components/SolutionsDropdown/styles.module.css" ) ,
2022-08-26 16:29:01 -05:00
] ,
2021-03-05 00:12:12 -08:00
} ,
2023-03-13 11:37:24 -07:00
pages : {
path : "src/pages" ,
mdxPageComponent : "@theme/MDXPage" ,
} ,
2024-03-22 09:36:53 +09:00
googleTagManager : {
containerId : 'GTM-WK28RLTG' ,
} ,
2021-03-05 00:12:12 -08:00
} ,
] ,
] ,
plugins : [
2024-04-19 15:12:32 +09:00
[
'@docusaurus/plugin-client-redirects' ,
{
createRedirects ( existingPath ) {
if ( existingPath . includes ( '/docs' ) ) {
return [
existingPath . replace ( '/docs' , '/docs/next' ) ,
2024-04-30 08:02:33 +09:00
existingPath . replace ( '/docs' , '/docs/0.13.0' ) ,
existingPath . replace ( '/docs' , '/docs/0.12.1' ) ,
existingPath . replace ( '/docs' , '/docs/0.11.0' ) ,
existingPath . replace ( '/docs' , '/docs/0.10.5' ) ,
2024-04-19 15:12:32 +09:00
] ;
}
return undefined ; // Return a falsy value: no redirect created
} ,
} ,
] ,
2023-09-26 14:26:06 -05:00
[ "@docusaurus/plugin-ideal-image" , { quality : 100 , sizes : [ 320 , 640 , 1280 , 1440 , 1600 ] } ] ,
2021-10-21 15:49:44 -05:00
"docusaurus-plugin-sass" ,
2021-09-22 17:30:15 -07:00
[
"docusaurus-graphql-plugin" ,
{
schema : "./graphql/combined.graphql" ,
routeBasePath : "/docs/graphql" ,
} ,
2021-10-21 15:49:44 -05:00
] ,
2021-03-05 00:12:12 -08:00
// [
// require.resolve("@easyops-cn/docusaurus-search-local"),
// {
// // `hashed` is recommended as long-term-cache of index file is possible.
// hashed: true,
// language: ["en"],
// docsDir: "genDocs",
// blogDir: [],
// },
// ],
] ,
} ;