Merge pull request #786 from dlt-hub/d#/devel_docs

D#/devel docs

Author: sh-rp

docs/website/docs/running-in-production/alerting.md

@@ -40,5 +40,5 @@ receiving rich information on executed pipelines, including encountered errors a
 
 ## Slack
 
-Read [here](/docs/running-in-production/running#using-slack-to-send-messages) about how to send
+Read [here](./running#using-slack-to-send-messages) about how to send
 messages to Slack.

docs/website/docusaurus.config.js

@@ -1,5 +1,6 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
+require('dotenv').config()
 
 const lightCodeTheme = require('prism-react-renderer/themes/dracula');
 // const lightCodeTheme = require('prism-react-renderer/themes/github');
@@ -10,7 +11,7 @@ const config = {
   title: 'dlt Docs',
   tagline: 'data load tool',
   url: 'https://dlthub.com',
-  baseUrl: '/docs',
+  baseUrl: process.env.DOCUSAURUS_BASE_URL || '/docs',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'throw',
   favicon: 'img/favicon.ico',
@@ -29,6 +30,8 @@ const config = {
     locales: ['en'],
   },
 
+
+
   presets: [
     [
       '@docusaurus/preset-classic',
@@ -77,6 +80,7 @@ const config = {
           href: 'https://dlthub.com'
         },
         items: [
+          { label: 'dlt ' + (process.env.IS_MASTER_BRANCH ? "stable ": "devel ") + (process.env.DOCUSAURUS_DLT_VERSION || "0.0.1"), position: 'left', href: 'https://github.com/dlt-hub/dlt', className: 'version-navbar'  },
           {
             type: 'doc',
             docId: 'intro',
@@ -184,4 +188,15 @@ const config = {
   ],
 };
 
+if (!process.env.IS_MASTER_BRANCH && config.themeConfig) {
+  config.themeConfig.announcementBar = {
+    id: 'devel docs',
+    content:
+      'This is the development version of the dlt docs. <a target="_blank" rel="noopener noreferrer" href="https://dlthub.com/docs/intro">Go to the stable docs.</a>',
+    backgroundColor: '#4c4898',
+    textColor: '#fff',
+    isCloseable: false,
+  }
+}
+
 module.exports = config;

docs/website/package-lock.json

@@ -4,10 +4,10 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "PYTHONPATH=. poetry run pydoc-markdown && node tools/update_snippets.js && docusaurus start",
+    "start": "PYTHONPATH=. poetry run pydoc-markdown && node tools/update_snippets.js && node tools/update_version_env.js && docusaurus start",
     "watch-snippets": "node tools/update_snippets.js --watch",
-    "build": "PYTHONPATH=. poetry run pydoc-markdown && node tools/update_snippets.js && docusaurus build",
-    "build:netlify": "PYTHONPATH=. pydoc-markdown && node tools/update_snippets.js && docusaurus build --out-dir build/docs",
+    "build": "PYTHONPATH=. poetry run pydoc-markdown && node tools/update_snippets.js && node tools/update_version_env.js && docusaurus build",
+    "build:netlify": "PYTHONPATH=. pydoc-markdown && node tools/update_snippets.js && node tools/update_version_env.js && docusaurus build --out-dir build/docs",
     "swizzle": "docusaurus swizzle",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
@@ -27,7 +27,9 @@
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-twitter-embed": "^4.0.4",
-    "string-dedent": "^3.0.1"
+    "string-dedent": "^3.0.1",
+    "dotenv": "^16.3.1",
+    "toml": "^3.0.0"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.4.1"

docs/website/package.json

@@ -267,4 +267,21 @@ const sidebars = {
   ]
 };
 
+// on the master branch link to devel and vice versa
+if (process.env.IS_MASTER_BRANCH) {
+  sidebars.tutorialSidebar.push(    {
+    type: 'link',
+    label: 'Switch to Devel Docs',
+    href: 'https://dlthub.com/devel/intro',
+    className: 'learn-more-link',
+  })
+} else {
+  sidebars.tutorialSidebar.push(    {
+    type: 'link',
+    label: 'Switch to Stable Docs',
+    href: 'https://dlthub.com/docs/intro',
+    className: 'learn-more-link',
+  })
+}
+
 module.exports = sidebars;

docs/website/sidebars.js

@@ -38,7 +38,7 @@
   --ifm-active-toc-link-color:#4C4898;
   --docsearch-highlight-color:#191937 !important;
   --docsearch-hit-color: #191937 !important;
-
+  --ifm-footer-background-color: #E4E8F0;
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */
@@ -69,7 +69,7 @@
   --docsearch-hit-background: #191937 !important;
   --docsearch-hit-color: #ffffff !important;
   --ifm-color-primary-light:#f3ff36;
-
+  --ifm-footer-background-color: #191937;
 }
 
 body {
@@ -358,6 +358,21 @@ html[data-theme='dark'] .footer__item a:hover{
   display: none;
 }
 
+.version-navbar>svg {
+  display: none;
+}
+
+.switch-navbar>svg {
+  display: none;
+}
+
+.version-navbar {
+  pointer-events: none;
+  background: var(--ifm-color-primary-light);
+  border-radius: 16px;
+  color: var(--docsearch-text-color);
+  margin-right: 16px;
+}
 
 .github-navbar:hover,
 .slack-navbar:hover ,.navbar__items.navbar__items--right  .clean-btn:hover {
@@ -665,6 +680,24 @@ html[data-theme='dark'] .theme-doc-sidebar-menu.menu__list>li:nth-child(8)>div>[
   background-image: url(../../static/img/Reference-Active-1.svg);
 }
 
+/* Devel / Stable switch */
+
+.theme-doc-sidebar-menu.menu__list>li:nth-child(9)>a svg {
+  display: none;
+}
+
+.theme-doc-sidebar-menu.menu__list>li:nth-child(9)>a {
+  flex: none;
+}
+
+.theme-doc-sidebar-menu.menu__list>li:nth-child(9) {
+  margin-top:30px;
+  padding-top: 10px;
+  justify-content: center;
+  border-top: 1px solid;
+  border-color: var(--ifm-footer-background-color);
+}
+
 
 /* responsive css :start */
 
@@ -741,7 +774,7 @@ html[data-theme='dark'] .overlayButton:hover {
   left:0px;
   top: 50%;
   transform: translateY(-50%);
-  background-color: var(--ifm-background-color); ;
+  background-color: var(--ifm-background-color);
   z-index: 1002;
   left: calc(50% - 350px);
   padding: 30px;

docs/website/src/css/custom.css

@@ -0,0 +1,17 @@
+// creates an .env file with the current version of the dlt for consumption in docusaurus.config.js
+
+const { readFile, writeFile } = require('fs/promises')
+const tom = require('toml');
+
+const TOML_FILE = '../../pyproject.toml';
+const ENV_FILE = '.env'
+ 
+async function update_env() {  
+    const fileContent = await readFile(TOML_FILE, 'utf8');
+    const toml = tom.parse(fileContent);
+    const version = toml['tool']['poetry']['version'];
+    const envFileContent = `DOCUSAURUS_DLT_VERSION=${version}`;
+    await writeFile(ENV_FILE, envFileContent, 'utf8');
+}
+
+update_env();