diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md deleted file mode 100644 index d3032ef..0000000 --- a/blog/2019-05-28-first-blog-post.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -slug: first-blog-post -title: First Blog Post -authors: [slorber, yangshun] -tags: [hola, docusaurus] ---- - -Lorem ipsum dolor sit amet... - - - -...consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md deleted file mode 100644 index eb4435d..0000000 --- a/blog/2019-05-29-long-blog-post.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -slug: long-blog-post -title: Long Blog Post -authors: yangshun -tags: [hello, docusaurus] ---- - -This is the summary of a very long blog post, - -Use a `` comment to limit blog post size in the list view. - - - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx deleted file mode 100644 index 0c4b4a4..0000000 --- a/blog/2021-08-01-mdx-blog-post.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -slug: mdx-blog-post -title: MDX Blog Post -authors: [slorber] -tags: [docusaurus] ---- - -Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). - -:::tip - -Use the power of React to create interactive blog posts. - -::: - -{/* truncate */} - -For example, use JSX to create an interactive button: - -```js - -``` - - diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg deleted file mode 100644 index 11bda09..0000000 Binary files a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg and /dev/null differ diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md deleted file mode 100644 index 349ea07..0000000 --- a/blog/2021-08-26-welcome/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -slug: welcome -title: Welcome -authors: [slorber, yangshun] -tags: [facebook, hello, docusaurus] ---- - -[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). - -Here are a few tips you might find useful. - - - -Simply add Markdown files (or folders) to the `blog` directory. - -Regular blog authors can be added to `authors.yml`. - -The blog post date can be extracted from filenames, such as: - -- `2019-05-30-welcome.md` -- `2019-05-30-welcome/index.md` - -A blog post folder can be convenient to co-locate blog post images: - -![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) - -The blog supports tags as well! - -**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. diff --git a/blog/authors.yml b/blog/authors.yml deleted file mode 100644 index 8bfa5c7..0000000 --- a/blog/authors.yml +++ /dev/null @@ -1,23 +0,0 @@ -yangshun: - name: Yangshun Tay - title: Front End Engineer @ Facebook - url: https://github.com/yangshun - image_url: https://github.com/yangshun.png - page: true - socials: - x: yangshunz - github: yangshun - -slorber: - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png - page: - # customize the url of the author page at /blog/authors/ - permalink: '/all-sebastien-lorber-articles' - socials: - x: sebastienlorber - linkedin: sebastienlorber - github: slorber - newsletter: https://thisweekinreact.com diff --git a/blog/tags.yml b/blog/tags.yml deleted file mode 100644 index bfaa778..0000000 --- a/blog/tags.yml +++ /dev/null @@ -1,19 +0,0 @@ -facebook: - label: Facebook - permalink: /facebook - description: Facebook tag description - -hello: - label: Hello - permalink: /hello - description: Hello tag description - -docusaurus: - label: Docusaurus - permalink: /docusaurus - description: Docusaurus tag description - -hola: - label: Hola - permalink: /hola - description: Hola tag description diff --git a/docs/Advanced/automated.md b/docs/Advanced/automated.md index df0f633..b99bdcc 100644 --- a/docs/Advanced/automated.md +++ b/docs/Advanced/automated.md @@ -1,3 +1,11 @@ +--- +id: automated-detection +title: "Automated Detection - Scheduled Threat Detection with Tempo" +description: "Learn how to configure automated threat detection schedules with Tempo. Set up continuous monitoring and automated inference workflows." +slug: /automated-detection +tags: [automated, detection, scheduling, monitoring, inference] +--- + # Automated Detection ## Important Notice ⚠️ diff --git a/docs/Advanced/finetune.md b/docs/Advanced/finetune.md index 407c0f9..a06649d 100644 --- a/docs/Advanced/finetune.md +++ b/docs/Advanced/finetune.md @@ -1,3 +1,11 @@ +--- +id: model-fine-tuning +title: "Model Fine-Tuning - Customizing Tempo for Your Environment" +description: "Advanced guide to fine-tuning Tempo's deep learning models for your specific environment. Improve detection accuracy with custom training." +slug: /model-fine-tuning +tags: [fine-tuning, models, customization, training, advanced] +--- + # Fine-tune Model To access fine-tuning features, contact support@DeepTempo.ai for activation. diff --git a/docs/SF_features.md b/docs/SF_features.md index b21821c..a4bb488 100644 --- a/docs/SF_features.md +++ b/docs/SF_features.md @@ -1,3 +1,11 @@ +--- +id: data-requirements +title: "Data Requirements - Using Your Own Data with Tempo" +description: "Learn the required data features and formats for running Tempo inference on your own datasets. Includes feature specifications and data preparation guidelines." +slug: /data-requirements +tags: [data, requirements, features, inference, datasets] +--- + # Use Your Own Data To run inference on your dataset, please ensure the following features are listed diff --git a/docs/Visualizations/Splunk.md b/docs/Visualizations/Splunk.md index 1bc3287..05e96cf 100644 --- a/docs/Visualizations/Splunk.md +++ b/docs/Visualizations/Splunk.md @@ -1,3 +1,11 @@ +--- +id: splunk-integration +title: "Splunk Integration - Viewing Tempo Results in Splunk Enterprise" +description: "Complete guide to integrating Tempo results with Splunk Enterprise. Set up visualizations, dashboards, and analysis tools for threat detection data." +slug: /splunk-integration +tags: [splunk, integration, visualization, dashboards, enterprise] +--- + # Viewing Results in Splunk This section guides you through setting up Splunk Enterprise to analyze the output from the Snowflake TEMPO project. This step is optional and intended for Splunk users who want a visualization of the output. For this doc we used a trial account on Splunk and we import the results of Tempo as CSV. In a production use case, you will likely use the Snowflake Splunk connector, DBConnect, as explained in the Snowflake documentation [here]: (https://community.snowflake.com/s/article/Integrating-Snowflake-and-Splunk-with-DBConnect) diff --git a/docs/mitreclass.md b/docs/mitreclass.md index 52919d8..c04a828 100644 --- a/docs/mitreclass.md +++ b/docs/mitreclass.md @@ -1,3 +1,11 @@ +--- +id: mitre-attack-classification +title: "MITRE ATT&CK Classification Guide - Threat Intelligence Mapping" +description: "Learn how to map detected anomalies to MITRE ATT&CK tactics and techniques using Tempo's classification system in Snowflake." +slug: /mitre-classification +tags: [mitre-attack, classification, threat-intelligence, tactics] +--- + # MITRE ATT&CK Classification Guide ## Overview diff --git a/docs/onPrem.md b/docs/onPrem.md index eb874ce..7034cad 100644 --- a/docs/onPrem.md +++ b/docs/onPrem.md @@ -1,3 +1,11 @@ +--- +id: on-premises-installation +title: "On-Premises Installation Guide - Tempo Deep Learning Security" +description: "Complete guide for deploying Tempo on-premises with Docker, Kubernetes, and GPU support. Includes prerequisites, deployment steps, and troubleshooting." +slug: /on-premises-install +tags: [installation, on-premises, docker, kubernetes, gpu] +--- + # Install ## Overview diff --git a/docs/onPremUse.md b/docs/onPremUse.md index d7d387a..b4aee59 100644 --- a/docs/onPremUse.md +++ b/docs/onPremUse.md @@ -1,3 +1,11 @@ +--- +id: on-premises-usage +title: "On-Premises Usage Guide - Forensichat Analysis Platform" +description: "Learn how to use Forensichat cybersecurity analysis platform on-premises. Investigate network traffic, analyze threats, and leverage deep learning insights." +slug: /on-premises-usage +tags: [on-premises, forensichat, analysis, cybersecurity, usage] +--- + # Guide ## Overview diff --git a/docs/snowCMD.md b/docs/snowCMD.md index d52f388..f223a89 100644 --- a/docs/snowCMD.md +++ b/docs/snowCMD.md @@ -1,3 +1,11 @@ +--- +id: snowflake-worksheets +title: "Tempo Snowflake Worksheets - SQL Commands and Procedures" +description: "Complete guide to using Tempo via Snowflake worksheets and SQL CLI. Learn database configuration, resource management, and threat detection commands." +slug: /snowflake-worksheets +tags: [snowflake, worksheets, sql, commands, cli] +--- + # Tempo Snowflake Worksheets ## Overview diff --git a/docs/snowUI.md b/docs/snowUI.md index 33ab018..e1ba4fb 100644 --- a/docs/snowUI.md +++ b/docs/snowUI.md @@ -1,3 +1,11 @@ +--- +id: snowflake-setup +title: "Snowflake Setup - Tempo Installation and Configuration" +description: "Complete setup guide for Tempo in Snowflake marketplace. Configure permissions, deploy the app, and start threat detection with deep learning." +slug: /snowflake-setup +tags: [snowflake, setup, installation, configuration] +--- + # Setup ## Overview diff --git a/docs/snowUsage.md b/docs/snowUsage.md index 6fae2ed..f09f4db 100644 --- a/docs/snowUsage.md +++ b/docs/snowUsage.md @@ -1,3 +1,11 @@ +--- +id: snowflake-usage +title: "Snowflake Usage Guide - Forensichat Analysis Platform" +description: "Complete guide to using Forensichat within Snowflake for cybersecurity analysis. Investigate network traffic and identify threats with deep learning." +slug: /snowflake-usage +tags: [snowflake, forensichat, analysis, cybersecurity, usage] +--- + # Guide ## Overview diff --git a/docs/snow_commandRef.md b/docs/snow_commandRef.md index ccc0855..cf3a95a 100644 --- a/docs/snow_commandRef.md +++ b/docs/snow_commandRef.md @@ -1,3 +1,11 @@ +--- +id: snowflake-command-reference-quick +title: "Snowflake Command Reference - Quick SQL Guide" +description: "Quick reference guide for Tempo SQL commands in Snowflake. Resource management, detection procedures, and investigation commands." +slug: /snowflake-command-reference +tags: [snowflake, commands, sql, reference, quick-guide] +--- + # Snowflake Tempo Command Reference ## Resource Management diff --git a/docs/snowflake.md b/docs/snowflake.md index d778ac3..e7536d6 100644 --- a/docs/snowflake.md +++ b/docs/snowflake.md @@ -1,3 +1,11 @@ +--- +id: snowflake-quickstart +title: "Snowflake Quickstart Guide - Tempo Deep Learning Integration" +description: "Learn how to deploy and use Tempo's deep learning threat detection in Snowflake. Step-by-step guide with anomaly detection and MITRE ATT&CK mapping." +slug: /snowflake-quickstart +tags: [snowflake, quickstart, deep-learning, threat-detection] +--- + # Snowflake Quickstart Guide ## Overview diff --git a/docusaurus.config.js b/docusaurus.config.js index 836d679..102383b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -32,6 +32,13 @@ const config = { i18n: { defaultLocale: 'en', locales: ['en'], + path: 'i18n', + localeConfigs: { + en: { + htmlLang: 'en-US', + direction: 'ltr', + }, + }, }, presets: [ @@ -50,15 +57,35 @@ const config = { theme: { customCss: './src/css/custom.css', }, + sitemap: { + changefreq: 'weekly', + priority: 0.5, + ignorePatterns: ['/tags/**'], + filename: 'sitemap.xml', + }, }), ], ], + // Performance optimizations can be added when dependencies are installed + + // Plugins will be added here when PWA dependencies are installed + plugins: [], + themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ // Replace with your project's social card image: 'img/DeepTempo-ai.png', + metadata: [ + {name: 'keywords', content: 'deep learning, cybersecurity, threat detection, network security, AI, machine learning, MITRE ATT&CK, anomaly detection'}, + {name: 'author', content: 'DeepTempo'}, + {name: 'robots', content: 'index,follow'}, + {property: 'og:type', content: 'website'}, + {property: 'og:site_name', content: 'DeepTempo Documentation'}, + {name: 'twitter:card', content: 'summary_large_image'}, + {name: 'twitter:site', content: '@DeepTempo'}, + ], navbar: { title: 'DeepTempo', logo: { @@ -73,13 +100,13 @@ const config = { position: 'left', }, { - to: '/docs/snowUI', + to: '/docs/snowflake-setup', label: 'Snowflake Setup', position: 'left', }, { - href: 'https://app.snowflake.com/marketplace/listing/GZTYZOYXHP3/deeptempo-cybersecurity-tempo', - label: 'Snowflake', + to: 'https://app.snowflake.com/marketplace/listing/GZTYZOYXHP3/deeptempo-cybersecurity-tempo', + label: 'Launch Snowflake', position: 'right', }, ], @@ -92,7 +119,7 @@ const config = { items: [ { label: 'Snowflake Setup', - to: '/docs/snowUI', + to: '/docs/snowflake-setup', }, ], }, diff --git a/package.json b/package.json index ec36fa7..d66ec18 100644 --- a/package.json +++ b/package.json @@ -16,12 +16,14 @@ "dependencies": { "@docusaurus/core": "3.5.2", "@docusaurus/preset-classic": "3.5.2", + "@docusaurus/plugin-pwa": "3.5.2", "@mdx-js/react": "^3.0.0", "clsx": "^2.0.0", "docusaurus": "^1.14.7", "prism-react-renderer": "^2.3.0", "react": "^18.0.0", - "react-dom": "^18.0.0" + "react-dom": "^18.0.0", + "swc-loader": "^0.2.6" }, "devDependencies": { "@docusaurus/module-type-aliases": "3.5.2", diff --git a/sidebars.js b/sidebars.js index 1ab9323..0f7d3dc 100644 --- a/sidebars.js +++ b/sidebars.js @@ -14,42 +14,51 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { tutorialSidebar: [ - + { + type: 'doc', + id: 'snowflake-quickstart', + label: 'Quick Start', + }, { type: 'category', - label: 'On-Premise', + label: 'Getting Started', + collapsed: false, items: [ - 'onPrem', - 'onPremUse', + 'snowflake-setup', + 'data-requirements', + ], + }, + { + type: 'category', + label: 'On-Premises', + items: [ + 'on-premises-installation', + 'on-premises-usage', + ], + }, + { + type: 'category', + label: 'Snowflake Platform', + items: [ + 'snowflake-usage', + 'snowflake-worksheets', + 'mitre-attack-classification', + 'snowflake-command-reference-quick', ], }, - { type: 'category', - label: 'Snowflake', + label: 'Advanced Features', items: [ - 'snowUI', - 'snowUsage', - { - type: 'category', - label: 'Worksheets', - items: [ - 'snowCMD', - 'SF_features', - 'mitreclass', - 'snow_commandRef', - 'Advanced/automated', - 'Advanced/finetune', - ], - }, + 'Advanced/automated-detection', + 'Advanced/model-fine-tuning', ], }, - { type: 'category', - label: 'Visualizations', + label: 'Integrations', items: [ - 'Visualizations/Splunk', + 'Visualizations/splunk-integration', ], } ], diff --git a/src/css/custom.css b/src/css/custom.css index 2a111f9..841aec4 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -82,6 +82,8 @@ color: #ffffff !important; } + + [data-theme='dark'] .navbar__item[href="/"]:hover { color: #cd2e16 !important; } \ No newline at end of file diff --git a/src/pages/index.js b/src/pages/index.js index 70341c0..0f09beb 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -19,7 +19,7 @@ function HomepageHeader() {
+ to="/docs/snowflake-setup"> Tempo Tutorial - 15min
@@ -32,11 +32,16 @@ export default function Home() { const {siteConfig} = useDocusaurusContext(); return ( + title="DeepTempo - Advanced Cybersecurity Threat Detection" + description="Advanced deep learning cybersecurity platform for network threat detection. Deploy Tempo on-premises or in Snowflake for AI-powered security analytics, MITRE ATT&CK mapping, and real-time anomaly detection.">
+
+
+
+ +
); diff --git a/static/manifest.json b/static/manifest.json new file mode 100644 index 0000000..8b712bb --- /dev/null +++ b/static/manifest.json @@ -0,0 +1,21 @@ +{ + "name": "DeepTempo Documentation", + "short_name": "DeepTempo Docs", + "description": "Deep learning cybersecurity threat detection documentation", + "start_url": "/", + "display": "standalone", + "background_color": "#ffffff", + "theme_color": "#25c2a0", + "icons": [ + { + "src": "/img/logo.png", + "sizes": "192x192", + "type": "image/png" + }, + { + "src": "/img/logo.png", + "sizes": "512x512", + "type": "image/png" + } + ] +} diff --git a/static/robots.txt b/static/robots.txt new file mode 100644 index 0000000..3dc8960 --- /dev/null +++ b/static/robots.txt @@ -0,0 +1,4 @@ +User-agent: * +Allow: / + +Sitemap: http://docs.deeptempo.ai/sitemap.xml