b5d18c1c74
## What Based on some customer feedback that our setup guides were a bit difficult to follow and they just wanted a one page step-by-step. - Adds a straight shooting one-page guide for folks embedding us into an existing application - Moves existing getting started guides that showcased demo applications into a "Tutorials" area This does depend on https://github.com/airbytehq/sonar/pull/1049 being merged, which moves the Applications Token endpoint to the public Sonar API (another request from that customer!)
377 lines
14 KiB
JavaScript
377 lines
14 KiB
JavaScript
// @ts-check
|
|
// Note: type annotations allow type checking and IDEs autocompletion
|
|
import "dotenv/config.js";
|
|
|
|
const { themes } = require("prism-react-renderer");
|
|
const lightCodeTheme = themes.github;
|
|
const darkCodeTheme = themes.dracula;
|
|
const npm2yarn = require("@docusaurus/remark-plugin-npm2yarn");
|
|
|
|
const docsHeaderDecoration = require("./src/remark/docsHeaderDecoration");
|
|
const enterpriseDocsHeaderInformation = require("./src/remark/enterpriseDocsHeaderInformation");
|
|
const productInformation = require("./src/remark/productInformation");
|
|
const connectorList = require("./src/remark/connectorList");
|
|
const specDecoration = require("./src/remark/specDecoration");
|
|
const docMetaTags = require("./src/remark/docMetaTags");
|
|
const addButtonToTitle = require("./src/remark/addButtonToTitle");
|
|
|
|
/** @type {import('@docusaurus/types').Config} */
|
|
const config = {
|
|
future: {
|
|
experimental_faster: true,
|
|
},
|
|
markdown: {
|
|
mermaid: true,
|
|
preprocessor: ({filePath, fileContent}) => {
|
|
return fileContent
|
|
.replace(/\{\{product_name_sm_oss\}\}/g, 'Core')
|
|
.replace(/\{\{product_name_sm_enterprise\}\}/g, 'Self-Managed Enterprise')
|
|
.replace(/\{\{product_name_cloud_standard\}\}/g, 'Standard')
|
|
.replace(/\{\{product_name_cloud_pro\}\}/g, 'Pro')
|
|
.replace(/\{\{product_name_cloud_enterprise\}\}/g, 'Enterprise Flex');
|
|
},
|
|
},
|
|
themes: [
|
|
"@docusaurus/theme-mermaid",
|
|
"@saucelabs/theme-github-codeblock",
|
|
"docusaurus-theme-openapi-docs",
|
|
],
|
|
title: "Airbyte Docs",
|
|
tagline:
|
|
"Airbyte is an open-source data integration platform to build ELT pipelines. Consolidate your data in your data warehouses, lakes and databases.",
|
|
url: "https://docs.airbyte.com/",
|
|
// Assumed relative path. If you are using airbytehq.github.io use /
|
|
// anything else should match the repo name
|
|
baseUrl: "/",
|
|
onBrokenLinks: "throw",
|
|
onBrokenMarkdownLinks: "throw",
|
|
favicon: "img/favicon.png",
|
|
organizationName: "airbytehq", // Usually your GitHub org/user name.
|
|
projectName: "airbyte", // Usually your repo name.
|
|
|
|
// Adds one off script tags to the head of each page
|
|
// e.g. <script async data-api-key="..." id="unifytag" src="..."></script>
|
|
scripts: [
|
|
{
|
|
src: "https://cdn.unifygtm.com/tag/v1/unify-tag-script.js",
|
|
async: true,
|
|
type: "module",
|
|
id: "unifytag",
|
|
"data-api-key": "wk_BEtrdAz2_2qgdexg5KRa6YWLWVwDdieFC7CAHkDKz",
|
|
},
|
|
{
|
|
src: "https://cdn.jsdelivr.net/npm/hockeystack@latest/hockeystack.min.js",
|
|
async: true,
|
|
"data-apikey": "2094e2379643f69f7aec647a15f786",
|
|
"data-cookieless": "1",
|
|
"data-auto-identify": "1",
|
|
},
|
|
],
|
|
headTags: [
|
|
{
|
|
tagName: "meta",
|
|
attributes: {
|
|
name: "zd-site-verification",
|
|
content: "plvcr4wcl9abmq0itvi63c",
|
|
},
|
|
},
|
|
...(process.env.NODE_ENV === "production" && process.env.SEGMENT_WRITE_KEY
|
|
? [
|
|
{
|
|
tagName: "script",
|
|
attributes: {
|
|
name: "segment-script",
|
|
},
|
|
innerHTML: `
|
|
!function(){var i="analytics",analytics=window[i]=window[i]||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","screen","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware","register"];analytics.factory=function(e){return function(){if(window[i].initialized)return window[i][e].apply(window[i],arguments);var n=Array.prototype.slice.call(arguments);if(["track","screen","alias","group","page","identify"].indexOf(e)>-1){var c=document.querySelector("link[rel='canonical']");n.push({__t:"bpc",c:c&&c.getAttribute("href")||void 0,p:location.pathname,u:location.href,s:location.search,t:document.title,r:document.referrer})}n.unshift(e);analytics.push(n);return analytics}};for(var n=0;n<analytics.methods.length;n++){var key=analytics.methods[n];analytics[key]=analytics.factory(key)}analytics.load=function(key,n){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.setAttribute("data-global-segment-analytics-key",i);t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(t,r);analytics._loadOptions=n};analytics._writeKey="${process.env.SEGMENT_WRITE_KEY}";;analytics.SNIPPET_VERSION="5.2.0";
|
|
analytics.load("${process.env.SEGMENT_WRITE_KEY}");
|
|
analytics.page();
|
|
}}();`,
|
|
},
|
|
]
|
|
: []),
|
|
],
|
|
i18n: {
|
|
defaultLocale: 'en',
|
|
locales: ['en'],
|
|
},
|
|
// The preset is the "main" docs instance, though in reality, most content does not live under this preset. See the plugins array below, which defines the behavior of each docs instance.
|
|
presets: [
|
|
[
|
|
"classic",
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
({
|
|
docs: {
|
|
routeBasePath: "/",
|
|
sidebarCollapsible: true,
|
|
sidebarPath: require.resolve("./sidebar.js"),
|
|
editUrl: "https://github.com/airbytehq/airbyte/blob/master/docs",
|
|
path: "../docs/home",
|
|
beforeDefaultRemarkPlugins: [specDecoration, connectorList], // use before-default plugins so TOC rendering picks up inserted headings
|
|
remarkPlugins: [
|
|
docsHeaderDecoration,
|
|
enterpriseDocsHeaderInformation,
|
|
productInformation,
|
|
docMetaTags,
|
|
addButtonToTitle,
|
|
],
|
|
},
|
|
blog: false,
|
|
theme: {
|
|
customCss: require.resolve("./src/css/custom.css"),
|
|
},
|
|
}),
|
|
],
|
|
],
|
|
plugins: [
|
|
// This plugin controls "platform" docs, which are versioned
|
|
[
|
|
"@docusaurus/plugin-content-docs",
|
|
{
|
|
id: "platform",
|
|
path: "../docs/platform",
|
|
routeBasePath: "/platform",
|
|
sidebarPath: "./sidebar-platform.js",
|
|
editUrl: ({ version, docPath }) => {
|
|
if (version === "current") {
|
|
// For the "next" (unreleased) version
|
|
return `https://github.com/airbytehq/airbyte/edit/master/docs/platform/${docPath}`;
|
|
} else {
|
|
// For released versions
|
|
return `https://github.com/airbytehq/airbyte/edit/master/docusaurus/platform_versioned_docs/version-${version}/${docPath}`;
|
|
}
|
|
},
|
|
remarkPlugins: [
|
|
docsHeaderDecoration,
|
|
enterpriseDocsHeaderInformation,
|
|
productInformation,
|
|
docMetaTags,
|
|
addButtonToTitle,
|
|
],
|
|
},
|
|
],
|
|
// This plugin controls AI Agent Tools docs, which are not versioned
|
|
[
|
|
"@docusaurus/plugin-content-docs",
|
|
{
|
|
id: "ai-agents",
|
|
path: "../docs/ai-agents",
|
|
routeBasePath: "/ai-agents",
|
|
sidebarPath: "./sidebar-ai-agents.js",
|
|
editUrl: "https://github.com/airbytehq/airbyte/blob/master/docs",
|
|
remarkPlugins: [
|
|
docsHeaderDecoration,
|
|
enterpriseDocsHeaderInformation,
|
|
productInformation,
|
|
docMetaTags,
|
|
addButtonToTitle,
|
|
[npm2yarn, { sync: true }],
|
|
],
|
|
},
|
|
],
|
|
// This plugin controls release notes, which are not versioned
|
|
[
|
|
"@docusaurus/plugin-content-docs",
|
|
{
|
|
id: "release_notes",
|
|
path: "../docs/release_notes",
|
|
routeBasePath: "/release_notes",
|
|
sidebarPath: "./sidebar-release_notes.js",
|
|
editUrl: "https://github.com/airbytehq/airbyte/blob/master/docs",
|
|
remarkPlugins: [
|
|
docsHeaderDecoration,
|
|
enterpriseDocsHeaderInformation,
|
|
productInformation,
|
|
docMetaTags,
|
|
addButtonToTitle,
|
|
],
|
|
},
|
|
],
|
|
// This plugin controls Connector docs, which are unversioned
|
|
[
|
|
"@docusaurus/plugin-content-docs",
|
|
{
|
|
id: "connectors",
|
|
path: "../docs/integrations",
|
|
routeBasePath: "/integrations",
|
|
sidebarPath: "./sidebar-connectors.js",
|
|
editUrl: "https://github.com/airbytehq/airbyte/blob/master/docs",
|
|
beforeDefaultRemarkPlugins: [specDecoration, connectorList], // use before-default plugins so TOC rendering picks up inserted headings
|
|
remarkPlugins: [
|
|
docsHeaderDecoration,
|
|
enterpriseDocsHeaderInformation,
|
|
productInformation,
|
|
docMetaTags,
|
|
],
|
|
},
|
|
],
|
|
require.resolve("./src/plugins/enterpriseConnectors"),
|
|
[
|
|
"@signalwire/docusaurus-plugin-llms-txt",
|
|
{
|
|
siteTitle: "docs.airbyte.com llms.txt",
|
|
siteDescription:
|
|
"Airbyte is an open source platform designed for building and managing data pipelines, offering extensive connector options to facilitate data movement from various sources to destinations efficiently and effectively.",
|
|
depth: 4,
|
|
content: {
|
|
includePages: true,
|
|
},
|
|
},
|
|
],
|
|
() => ({
|
|
name: "Yaml loader",
|
|
configureWebpack() {
|
|
return {
|
|
module: {
|
|
rules: [
|
|
{
|
|
test: /\.ya?ml$/,
|
|
use: "yaml-loader",
|
|
},
|
|
{
|
|
test: /\.html$/i,
|
|
loader: "html-loader",
|
|
},
|
|
],
|
|
},
|
|
};
|
|
},
|
|
}),
|
|
],
|
|
customFields: {
|
|
requestErdApiUrl: process.env.REQUEST_ERD_API_URL,
|
|
markpromptProjectKey:
|
|
process.env.MARKPROMPT_PROJECT_KEY ||
|
|
"sk_test_cbPFAzAxUvafRj6l1yjzrESu0bRpzQGK",
|
|
},
|
|
clientModules: [
|
|
require.resolve("./src/scripts/cloudStatus.js"),
|
|
require.resolve("./src/scripts/download-abctl-buttons.js"),
|
|
require.resolve("./src/scripts/fontAwesomeIcons.js"),
|
|
],
|
|
|
|
themeConfig:
|
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
|
({
|
|
colorMode: {
|
|
disableSwitch: false,
|
|
},
|
|
mermaid: {
|
|
theme: {
|
|
light: 'base', // "base" theme is fully customizable
|
|
dark: 'base'
|
|
},
|
|
options: {
|
|
themeVariables: {
|
|
primaryColor: '#5F5CFF', // Airbyte blue
|
|
primaryTextColor: '#FFFFFF', // white labels on colored shapes
|
|
primaryBorderColor: '#1A194D', // slightly darker for contrast
|
|
secondaryColor: '#FF6A4D', // accent orange
|
|
// secondaryTextColor: '#FF6A4D', // accent orange
|
|
// secondaryBorderColor: '#FF6A4D', // accent orange
|
|
tertiaryColor: '#E8EAF6', // light neutral fill
|
|
tertiaryTextColor: '#000000', // black labels on light shapes
|
|
tertiaryBorderColor: '#E8EAF6', // light neutral border
|
|
background: '#FFFFFF',
|
|
clusterBkg: '#F5F5F5',
|
|
fontFamily: 'var(--ifm-font-family-base)',
|
|
},
|
|
flowchart: {
|
|
rankSpacing: 100, // vertical space
|
|
subGraphTitleMargin: 10, // space within subgraph border for title
|
|
nodeSpacing: 100, // horizontal space
|
|
},
|
|
},
|
|
},
|
|
docs: {
|
|
sidebar: {
|
|
autoCollapseCategories: true,
|
|
},
|
|
},
|
|
algolia: {
|
|
appId: "OYKDBC51MU",
|
|
apiKey: "15c487fd9f7722282efd8fcb76746fce", // Public API key: it is safe to commit it
|
|
indexName: "airbyte",
|
|
},
|
|
announcementBar: {
|
|
id: "try_airbyte_cloud",
|
|
content:
|
|
'<a target="_blank" rel="noopener noreferrer" href="https://cloud.airbyte.io/signup?utm_campaign=22Q1_AirbyteCloudSignUpCampaign_Trial&utm_source=Docs&utm_content=NavBar">Try Airbyte Cloud</a>! Free for 30 days, no credit card needed.',
|
|
backgroundColor: "#615eff",
|
|
textColor: "#ffffff",
|
|
isCloseable: true,
|
|
},
|
|
navbar: {
|
|
title: "Docs",
|
|
logo: {
|
|
alt: "Simple, secure and extensible data integration",
|
|
src: "img/logo-dark.png",
|
|
srcDark: "img/logo-light.png",
|
|
height: 40,
|
|
},
|
|
items: [
|
|
{
|
|
type: "docSidebar",
|
|
position: "left",
|
|
docsPluginId: "platform",
|
|
sidebarId: "platform",
|
|
label: "Platform",
|
|
},
|
|
{
|
|
type: "docSidebar",
|
|
position: "left",
|
|
docsPluginId: "connectors",
|
|
sidebarId: "connectors",
|
|
label: "Connectors",
|
|
},
|
|
{
|
|
type: "docSidebar",
|
|
position: "left",
|
|
docsPluginId: "release_notes",
|
|
sidebarId: "releaseNotes",
|
|
label: "Release notes",
|
|
},
|
|
{
|
|
type: "docSidebar",
|
|
position: "left",
|
|
docsPluginId: "ai-agents",
|
|
sidebarId: "ai-agents",
|
|
label: "AI Agents",
|
|
},
|
|
{
|
|
href: "https://support.airbyte.com/",
|
|
label: "Support",
|
|
},
|
|
|
|
{
|
|
href: "https://status.airbyte.com",
|
|
label: "Status",
|
|
className: "cloudStatusLink",
|
|
},
|
|
// --- Right side ---
|
|
// Platform docs version selector
|
|
{
|
|
type: "docsVersionDropdown",
|
|
position: "right",
|
|
docsPluginId: "platform",
|
|
label: "Version",
|
|
dropdownActiveClassDisabled: true, // do not style the dropdown as active when viewing platform docs
|
|
},
|
|
{
|
|
href: "https://github.com/airbytehq",
|
|
position: "right",
|
|
"aria-label": "Airbyte on GitHub",
|
|
className: "header-github-link",
|
|
},
|
|
],
|
|
},
|
|
prism: {
|
|
theme: lightCodeTheme,
|
|
darkTheme: darkCodeTheme,
|
|
additionalLanguages: ["bash", "diff", "json", "hcl"],
|
|
},
|
|
}),
|
|
};
|
|
|
|
module.exports = config;
|