Skip to content

Commit

Permalink
feat: add full story script (#1610)
Browse files Browse the repository at this point in the history 
## Description:
Adding Full Story to our docs page. Full disclosure, I haven't been able
to test if this actually works so a follow up PR may be needed

## Is this change user facing?
NO
<!-- If yes, please add the "user facing" label to the PR -->
<!-- If yes, don't forget to include docs changes where relevant -->

## References (if applicable):
  • Loading branch information
@adschwartz
adschwartz authored Oct 24, 2023
1 parent 64d7273 commit de10c7b
Show file tree
Hide file tree
Showing 2 changed files with 192 additions and 165 deletions.
336 changes: 171 additions & 165 deletions docs/docusaurus.config.js
View file
Original file line number Diff line number Diff line change
@@ -1,184 +1,190 @@
// @ts-check
// @ts-check

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/vsDark');

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Kurtosis Docs',
tagline: 'Next-gen developer experience for building, testing, and running distributed systems.',
url: 'https://docs.kurtosis.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: 'img/favicon.ico',
title: 'Kurtosis Docs',
tagline: 'Next-gen developer experience for building, testing, and running distributed systems.',
url: 'https://docs.kurtosis.com',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: 'img/favicon.ico',

// GitHub pages deployment config.
organizationName: 'kurtosis-tech',
projectName: 'docs',
// GitHub pages deployment config.
organizationName: 'kurtosis-tech',
projectName: 'docs',

i18n: {
defaultLocale: 'en',
locales: ['en'],
},
i18n: {
defaultLocale: 'en',
locales: ['en'],
},

presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
routeBasePath: '/',
admonitions: {}, // Add this line to enable admonitions
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
routeBasePath: '/',
admonitions: {}, // Add this line to enable admonitions

// TODO TODO Run Remark plugins through Docusaurus itself (right now we're running it via yarn and package.json)!! See https://docusaurus.io/docs/markdown-features/plugins#installing-plugins

},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
gtag: {
trackingID: 'G-9D2YD4C5FV',
},
}),
],
],
// TODO TODO Run Remark plugins through Docusaurus itself (right now we're running it via yarn and package.json)!! See https://docusaurus.io/docs/markdown-features/plugins#installing-plugins

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
announcementBar: {
id: 'support_us',
content:
'<a target="_blank" rel="noopener noreferrer" href="https://github.com/kurtosis-tech/kurtosis">Support Kurtosis with a star on our Github repo!</a>',
backgroundColor: '#1b1b1d',
textColor: '#909294',
isCloseable: false,
},
colorMode: {
defaultMode: 'dark',
disableSwitch: true,
respectPrefersColorScheme: false,
},
navbar: {
logo: {
alt: 'Kurtosis',
src: 'img/brand/kurtosis-logo-white-text.png',
href: 'https://kurtosis.com',
target: '_self'
},
items: [
{
to: '/quickstart',
position: 'left',
label: 'Quickstart',
activeBasePath: '/quickstart'
},
{
to: '/cli',
position: 'left',
label: 'CLI',
activeBasePath: '/cli'
},
{
to: '/starlark-reference',
position: 'left',
label: 'Starlark',
activeBasePath: '/sdk'
},
{
href: 'https://web3.kurtosis.com',
position: 'left',
label: 'Kurtosis for Web3',
},
{
href: 'https://github.com/kurtosis-tech/kurtosis/issues/new?assignees=leeederek&labels=docs&template=docs-issue.yml',
position: 'right',
label: 'Report Docs Issue',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Quickstart',
to: '/quickstart',
},
{
label: 'CLI',
to: '/cli',
},
{
label: 'Starlark',
to: '/starlark-reference',
},
{
label: 'Kurtosis for Web3',
href: 'https://web3.kurtosis.com',
},
],
},
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.gg/HUapYX9RvV',
},
{
label: 'Twitter',
href: 'https://twitter.com/KurtosisTech',
},
{
label: 'GitHub',
href: 'https://github.com/kurtosis-tech',
},
],
},
{
title: 'Company',
items: [
{
label: `Careers - We're Hiring`,
href: 'https://www.kurtosis.com/careers',
},
{
label: 'About Us',
href: 'https://www.kurtosis.com/company',
},
{
label: 'Blog',
href: 'https://www.kurtosis.com/blog',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Kurtosis Technologies`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
algolia: {
appId: 'NTSX40VZB8',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
gtag: {
trackingID: 'G-9D2YD4C5FV',
},
}),
],
],

// Public API key, safe to commit
apiKey: '4269c726c2fea4e6cddfeb9a21cd3d4e',
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
announcementBar: {
id: 'support_us',
content:
'<a target="_blank" rel="noopener noreferrer" href="https://github.com/kurtosis-tech/kurtosis">Support Kurtosis with a star on our Github repo!</a>',
backgroundColor: '#1b1b1d',
textColor: '#909294',
isCloseable: false,
},
colorMode: {
defaultMode: 'dark',
disableSwitch: true,
respectPrefersColorScheme: false,
},
navbar: {
logo: {
alt: 'Kurtosis',
src: 'img/brand/kurtosis-logo-white-text.png',
href: 'https://kurtosis.com',
target: '_self'
},
items: [
{
to: '/quickstart',
position: 'left',
label: 'Quickstart',
activeBasePath: '/quickstart'
},
{
to: '/cli',
position: 'left',
label: 'CLI',
activeBasePath: '/cli'
},
{
to: '/starlark-reference',
position: 'left',
label: 'Starlark',
activeBasePath: '/sdk'
},
{
href: 'https://web3.kurtosis.com',
position: 'left',
label: 'Kurtosis for Web3',
},
{
href: 'https://github.com/kurtosis-tech/kurtosis/issues/new?assignees=leeederek&labels=docs&template=docs-issue.yml',
position: 'right',
label: 'Report Docs Issue',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Quickstart',
to: '/quickstart',
},
{
label: 'CLI',
to: '/cli',
},
{
label: 'Starlark',
to: '/starlark-reference',
},
{
label: 'Kurtosis for Web3',
href: 'https://web3.kurtosis.com',
},
],
},
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.gg/HUapYX9RvV',
},
{
label: 'Twitter',
href: 'https://twitter.com/KurtosisTech',
},
{
label: 'GitHub',
href: 'https://github.com/kurtosis-tech',
},
],
},
{
title: 'Company',
items: [
{
label: `Careers - We're Hiring`,
href: 'https://www.kurtosis.com/careers',
},
{
label: 'About Us',
href: 'https://www.kurtosis.com/company',
},
{
label: 'Blog',
href: 'https://www.kurtosis.com/blog',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Kurtosis Technologies`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
algolia: {
appId: 'NTSX40VZB8',

indexName: 'kurtosis',
// Public API key, safe to commit
apiKey: '4269c726c2fea4e6cddfeb9a21cd3d4e',

contextualSearch: true,
indexName: 'kurtosis',

searchParameters: {},
contextualSearch: true,

searchPagePath: 'search',
},
}),
searchParameters: {},

searchPagePath: 'search',
},
}),
scripts: [
{
src: '/js/load-fullstory.js',
async: false,
}
]
};

module.exports = config;
21 changes: 21 additions & 0 deletions docs/static/js/load-fullstory.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
window['_fs_host'] = 'fullstory.com';
window['_fs_script'] = 'edge.fullstory.com/s/fs.js';
window['_fs_org'] = 'o-1RQ4W2-na1';
window['_fs_namespace'] = 'FS';
(function(m,n,e,t,l,o,g,y){
if (e in m) {if(m.console && m.console.log) { m.console.log('FullStory namespace conflict. Please set window["_fs_namespace"].');} return;}
g=m[e]=function(a,b,s){g.q?g.q.push([a,b,s]):g._api(a,b,s);};g.q=[];
o=n.createElement(t);o.async=1;o.crossOrigin='anonymous';o.src='https://'+_fs_script;
y=n.getElementsByTagName(t)[0];y.parentNode.insertBefore(o,y);
g.identify=function(i,v,s){g(l,{uid:i},s);if(v)g(l,v,s)};g.setUserVars=function(v,s){g(l,v,s)};g.event=function(i,v,s){g('event',{n:i,p:v},s)};
g.anonymize=function(){g.identify(!!0)};
g.shutdown=function(){g("rec",!1)};g.restart=function(){g("rec",!0)};
g.log = function(a,b){g("log",[a,b])};
g.consent=function(a){g("consent",!arguments.length||a)};
g.identifyAccount=function(i,v){o='account';v=v||{};v.acctId=i;g(o,v)};
g.clearUserCookie=function(){};
g.setVars=function(n, p){g('setVars',[n,p]);};
g._w={};y='XMLHttpRequest';g._w[y]=m[y];y='fetch';g._w[y]=m[y];
if(m[y])m[y]=function(){return g._w[y].apply(this,arguments)};
g._v="1.3.0";
})(window,document,window['_fs_namespace'],'script','user');

0 comments on commit de10c7b

Please sign in to comment.