From 887c4d61ff21473df09c83e0bd82758c146ba26e Mon Sep 17 00:00:00 2001 From: Rob Larkman Date: Tue, 26 May 2026 15:43:25 +0100 Subject: [PATCH 1/4] redesign --- .gitmodules | 3 - assets/_relearn_searchindex.js | 21 -- assets/css/theme-splunk-dark.css | 108 -------- assets/css/theme-splunk-light.css | 65 ----- assets/js/search.js | 239 ++++++++++++++++++ config.yaml | 83 ------ content/_index.md | 33 +-- content/account-settings/_index.md | 16 +- content/account-settings/notifications.md | 24 +- content/account-settings/preferences.md | 16 +- content/account-settings/salesforce.md | 16 +- content/catalog/_index.md | 26 +- content/demos/_index.md | 16 +- content/demos/always-on-demos.md | 18 +- content/demos/creating-demos.md | 36 +-- content/demos/managing-demos.md | 52 ++-- content/demos/shared-demos.md | 20 +- content/finding-content/_index.md | 16 +- .../view-template-information.md | 18 +- content/my-page/_index.md | 22 +- content/public-page/_index.md | 12 +- content/signing-in/_index.md | 8 +- content/support/_index.md | 14 +- content/support/content-feedback.md | 14 +- content/support/feature-requests.md | 8 +- content/support/infrastructure.md | 14 +- content/workshops/_index.md | 16 +- content/workshops/creating-workshops.md | 60 ++--- content/workshops/event-quick-start/_index.md | 18 +- .../event-quick-start/anonymous-passcodes.md | 14 +- .../choosing-workshop-type.md | 10 +- .../event-quick-start/creating-an-event.md | 20 +- .../event-quick-start/inviting-attendees.md | 18 +- .../event-quick-start/what-is-an-event.md | 8 +- content/workshops/manage-events.md | 70 ++--- content/workshops/managing-workshops.md | 34 +-- go.mod | 5 + go.sum | 2 + hugo.toml | 99 ++++++++ i18n/en.yaml | 8 + layouts/_partials/custom-header.html | 68 +++++ layouts/_partials/sidebar.html | 36 +++ layouts/_partials/workshop-root.html | 23 ++ layouts/partials/assetbusting.gotmpl | 12 - layouts/partials/content-header.html | 1 - layouts/partials/content-lead.html | 43 ---- layouts/partials/custom-head.html | 2 - layouts/partials/custom-header.html | 4 - layouts/partials/logo.html | 3 - layouts/partials/menu-footer.html | 3 - static/css/custom.css | 84 ------ themes/relearn | 1 - 52 files changed, 807 insertions(+), 773 deletions(-) delete mode 100644 .gitmodules delete mode 100644 assets/_relearn_searchindex.js delete mode 100644 assets/css/theme-splunk-dark.css delete mode 100644 assets/css/theme-splunk-light.css create mode 100644 assets/js/search.js delete mode 100644 config.yaml create mode 100644 go.mod create mode 100644 go.sum create mode 100644 hugo.toml create mode 100644 i18n/en.yaml create mode 100644 layouts/_partials/custom-header.html create mode 100644 layouts/_partials/sidebar.html create mode 100644 layouts/_partials/workshop-root.html delete mode 100644 layouts/partials/assetbusting.gotmpl delete mode 100644 layouts/partials/content-header.html delete mode 100644 layouts/partials/content-lead.html delete mode 100644 layouts/partials/custom-head.html delete mode 100644 layouts/partials/custom-header.html delete mode 100644 layouts/partials/logo.html delete mode 100644 layouts/partials/menu-footer.html delete mode 100644 static/css/custom.css delete mode 160000 themes/relearn diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index c2927ad..0000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "themes/relearn"] - path = themes/relearn - url = https://github.com/McShelby/hugo-theme-relearn.git diff --git a/assets/_relearn_searchindex.js b/assets/_relearn_searchindex.js deleted file mode 100644 index 1f61f6d..0000000 --- a/assets/_relearn_searchindex.js +++ /dev/null @@ -1,21 +0,0 @@ -{{- $pages := slice }} -{{- range site.Pages }} - {{- if partial "_relearn/pageIsSpecial.gotmpl" . }} - {{- else if .Params.searchExclude }} - {{- /* Skip pages with searchExclude = true in front matter */ -}} - {{- else if and .Title .RelPermalink (or (ne site.Params.disableSearchHiddenPages true) (not (partialCached "_relearn/pageIsHiddenSelfOrAncestor.gotmpl" (dict "page" . "to" site.Home) .Path site.Home.Path) ) ) }} - {{- $tags := slice }} - {{- range .GetTerms "tags" }} - {{- $tags = $tags | append (partial "title.gotmpl" (dict "page" .Page "linkTitle" true) | plainify) }} - {{- end }} - {{- $pages = $pages | append (dict - "uri" (partial "permalink.gotmpl" (dict "to" .)) - "title" (partial "title.gotmpl" (dict "page" .) | plainify) - "tags" $tags - "breadcrumb" (trim (partial "breadcrumbs.html" (dict "page" . "dirOnly" true) | plainify | htmlUnescape) "\n\r\t ") - "description" (trim (or .Description .Summary | plainify | htmlUnescape) "\n\r\t " ) - "content" (trim (.Plain | htmlUnescape) "\n\r\t ") - ) }} - {{- end }} -{{- end -}} -var relearn_searchindex = {{ $pages | jsonify (dict "indent" " ") }} diff --git a/assets/css/theme-splunk-dark.css b/assets/css/theme-splunk-dark.css deleted file mode 100644 index b30502f..0000000 --- a/assets/css/theme-splunk-dark.css +++ /dev/null @@ -1,108 +0,0 @@ -:root { - /* my-custom-variant */ - --PRIMARY-color: rgba( 206, 0, 112, 1 ); /* brand primary color */ - --SECONDARY-color: rgba( 206, 0, 112, 1 ); /* brand secondary color */ - --ACCENT-color: rgb( 255, 102, 78, 1 ); /* brand accent color, used for search highlights */ - --MAIN-LINK-HOVER-color: rgba( 255, 130, 180, 1 ); /* hoverd link color of content */ - --MAIN-BG-color: rgba( 32, 32, 32, 1 ); /* background color of content */ - --MAIN-TEXT-color: rgba( 224, 224, 224, 1 ); /* text color of content and h1 titles */ - --MAIN-TITLES-TEXT-color: rgba( 255, 255, 255, 1 ); /* text color of h2-h6 titles and transparent box titles */ - --CODE-theme: relearn-dark; /* name of the chroma stylesheet file */ - --CODE-BLOCK-color: rgba( 248, 248, 242, 1 ); /* fallback text color of block code; should be adjusted to your selected chroma style */ - --CODE-BLOCK-BG-color: rgba( 43, 43, 43, 1 ); /* fallback background color of block code; should be adjusted to your selected chroma style */ - --CODE-BLOCK-BORDER-color: rgba( 71, 71, 71, 1 ); /* border color of block code */ - --CODE-INLINE-color: rgba( 130, 229, 80, 1 ); /* text color of inline code */ - --CODE-INLINE-BG-color: rgba( 45, 45, 45, 1 ); /* background color of inline code */ - --CODE-INLINE-BORDER-color: rgba( 70, 70, 70, 1 ); /* border color of inline code */ - --BROWSER-theme: dark; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ - --OPENAPI-theme: dark; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ - --OPENAPI-CODE-theme: obsidian; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ - --MENU-HEADER-BORDER-color: rgba( 0, 0, 0, 1); /* border color of the menu header */ - --MENU-VISITED-color: rgba( 255, 130, 180, 1 ); /* icon color of visited menu topics if configured */ - - --MENU-HOME-LINK-color: rgba(255, 255, 255, 1); /* home button color if configured */ - --MENU-HOME-LINK-HOVER-color: rgba( 206, 0, 112, 1 ); /* hoverd home button color if configured */ - --MENU-HOME-TOP-SEPARATOR-color: rgba( 16, 16, 16, 1 ); /* separator color between home button and menu sections */ - --MENU-SEARCH-color: rgba( 224, 224, 224, 1 ); /* text and icon color of search box */ - --MENU-SEARCH-BG-color: rgba( 50, 50, 50, 1 ); /* background color of search box */ - --MENU-SEARCH-BORDER-color: rgba( 224, 224, 224, 1 ); /* border color of search box */ - --MENU-SECTIONS-BG-color: rgba( 43, 43, 43, 1 ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */ - --MENU-SECTIONS-ACTIVE-BG-color: rgba( 50, 50, 50, 1 ); /* background color of the active menu section */ - --MENU-SECTIONS-LINK-color: rgba( 186, 186, 186, 1 ); /* link color of menu topics */ - --MENU-SECTIONS-LINK-HOVER-color: rgba( 255, 255, 255, 1 ); /* hoverd link color of menu topics */ - --MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 249, 157,28, 1 ); /* text color of the displayed menu topic */ - --MENU-SECTION-SEPARATOR-color: rgba( 96, 96, 96, 1 ); /* separator color between menu sections and menu footer */ - --BOX-CAPTION-color: rgba( 240, 240, 240, 1 ); /* text color of colored box titles */ - --BOX-BG-color: rgba( 20, 20, 20, 1 ); /* background color of colored boxes */ - --BOX-TEXT-color: rgba( 224, 224, 224, 1 ); /* text color of colored box content */ - } - - /* Custom heading styles for improved readability */ - #R-body-inner h1 { - font-size: 2rem; - font-weight: 700; - text-transform: none; - } - - #R-body-inner h2 { - font-size: 1.6rem; - font-weight: 700; - text-transform: none; - } - - #R-body-inner h3 { - font-size: 1.3rem; - font-weight: 700; - text-transform: none; - } - - #R-body-inner h4, - #R-body-inner h5, - #R-body-inner h6 { - font-weight: 700; - text-transform: none; - } - - /* Override link colors in main content for better readability */ - #R-body-inner a { - color: rgba(240, 100, 160, 1) !important; - } - - #R-body-inner a:hover { - color: rgba(255, 130, 180, 1) !important; - } - - /* Override reading time badge color */ - .reading-time-badge { - color: rgba(240, 100, 160, 1) !important; - } - - /* Override navigation text colors */ - .topbar-breadcrumbs a, - .topbar-button a, - .topbar-button button { - color: rgba(240, 100, 160, 1) !important; - } - - .topbar-breadcrumbs a:hover, - .topbar-button a:hover, - .topbar-button button:hover { - color: rgba(255, 130, 180, 1) !important; - } - - /* Override search results text colors */ - #R-search-results a, - .search-results a, - .autocomplete-suggestion a, - .autocomplete-suggestion span, - #R-search-results .search-section-header, - .autocomplete-suggestion strong { - color: rgba(240, 100, 160, 1) !important; - } - - #R-search-results a:hover, - .search-results a:hover, - .autocomplete-suggestion a:hover { - color: rgba(255, 130, 180, 1) !important; - } \ No newline at end of file diff --git a/assets/css/theme-splunk-light.css b/assets/css/theme-splunk-light.css deleted file mode 100644 index 3a12988..0000000 --- a/assets/css/theme-splunk-light.css +++ /dev/null @@ -1,65 +0,0 @@ -:root { - /* my-custom-variant */ - --PRIMARY-color: rgba( 206, 0, 112, 1 ); /* brand primary color */ - --SECONDARY-color: rgba( 206, 0, 112, 1 ); /* brand secondary color */ - --ACCENT-color: rgb( 255, 102, 78, 1 ); /* brand accent color, used for search highlights */ - --MAIN-LINK-HOVER-color: rgba( 206, 0, 112, 1 ); /* hoverd link color of content */ - --MAIN-BG-color: rgba( 255, 255, 255, 1 ); /* background color of content */ - --MAIN-TEXT-color: rgba( 0, 0, 0, 1 ); /* text color of content and h1 titles */ - --MAIN-TITLES-TEXT-color: rgba( 16, 16, 16, 1 ); /* text color of h2-h6 titles and transparent box titles */ - --CODE-theme: relearn-light; /* name of the chroma stylesheet file */ - --CODE-BLOCK-color: rgba( 39, 40, 34, 1 ); /* fallback text color of block code; should be adjusted to your selected chroma style */ - --CODE-BLOCK-BG-color: rgba( 250, 250, 250, 1 ); /* fallback background color of block code; should be adjusted to your selected chroma style */ - --CODE-BLOCK-BORDER-color: rgba( 216, 216, 216, 1 ); /* border color of block code */ - --CODE-INLINE-color: rgba( 94, 94, 94, 1 ); /* text color of inline code */ - --CODE-INLINE-BG-color: rgba( 255, 250, 233, 1 ); /* background color of inline code */ - --CODE-INLINE-BORDER-color: rgba( 248, 232, 200, 1 ); /* border color of inline code */ - --BROWSER-theme: light; /* name of the theme for browser scrollbars of the main section */ - --MERMAID-theme: dark; /* name of the default Mermaid theme for this variant, can be overridden in hugo.toml */ - --OPENAPI-theme: light; /* name of the default OpenAPI theme for this variant, can be overridden in hugo.toml */ - --OPENAPI-CODE-theme: idea; /* name of the default OpenAPI code theme for this variant, can be overridden in hugo.toml */ - --MENU-HEADER-BORDER-color: rgba( 0, 0, 0, 1); /* border color of the menu header */ - --MENU-VISITED-color: rgba( 206, 0, 112, 1 ); /* icon color of visited menu topics if configured */ - - --MENU-HOME-LINK-color: rgba(255, 255, 255, 1); /* home button color if configured */ - --MENU-HOME-LINK-HOVER-color: rgba( 206, 0, 112, 1 ); /* hoverd home button color if configured */ - --MENU-HOME-TOP-SEPARATOR-color: rgba( 16, 16, 16, 1 ); /* separator color between home button and menu sections */ - --MENU-SEARCH-color: rgba( 224, 224, 224, 1 ); /* text and icon color of search box */ - --MENU-SEARCH-BG-color: rgba( 50, 50, 50, 1 ); /* background color of search box */ - --MENU-SEARCH-BORDER-color: rgba( 224, 224, 224, 1 ); /* border color of search box */ - --MENU-SECTIONS-BG-color: rgba( 43, 43, 43, 1 ); /* background of the menu; this is NOT just a color value but can be a complete CSS background definition including gradients, etc. */ - --MENU-SECTIONS-ACTIVE-BG-color: rgba( 50, 50, 50, 1 ); /* background color of the active menu section */ - --MENU-SECTIONS-LINK-color: rgba( 186, 186, 186, 1 ); /* link color of menu topics */ - --MENU-SECTIONS-LINK-HOVER-color: rgba( 255, 255, 255, 1 ); /* hoverd link color of menu topics */ - --MENU-SECTION-ACTIVE-CATEGORY-color: rgba( 68, 68, 68, 1 ); /* text color of the displayed menu topic */ - --MENU-SECTION-SEPARATOR-color: rgba( 96, 96, 96, 1 ); /* separator color between menu sections and menu footer */ - --BOX-CAPTION-color: rgba( 255, 255, 255, 1 ); /* text color of colored box titles */ - --BOX-BG-color: rgba( 255, 255, 255, .833 ); /* background color of colored boxes */ - --BOX-TEXT-color: rgba( 16, 16, 16, 1 ); /* text color of colored box content */ - } - - /* Custom heading styles for improved readability */ - #R-body-inner h1 { - font-size: 2rem; - font-weight: 700; - text-transform: none; - } - - #R-body-inner h2 { - font-size: 1.6rem; - font-weight: 700; - text-transform: none; - } - - #R-body-inner h3 { - font-size: 1.3rem; - font-weight: 700; - text-transform: none; - } - - #R-body-inner h4, - #R-body-inner h5, - #R-body-inner h6 { - font-weight: 700; - text-transform: none; - } \ No newline at end of file diff --git a/assets/js/search.js b/assets/js/search.js new file mode 100644 index 0000000..107be1a --- /dev/null +++ b/assets/js/search.js @@ -0,0 +1,239 @@ +// Site search — vanilla JS modal over the JSON index produced by the home +// page's JSON output format. The actual path is language- and baseURL- +// dependent (`/en/index.json`, `/ja/index.json`, `/workshop/en/index.json`, +// …); the URL is read at runtime from the `` +// tag Hugo emits in head.html. +// +// Triggers: header button, "/" key, Cmd/Ctrl-K. Results live-updated as you type. +// Closes: Esc, click outside, click a result. +// +// Scoring is intentionally simple — substring + word-prefix bonuses. Workshops +// rarely have enough pages to need a real ranking algorithm, and a small +// dependency-free matcher beats pulling in Fuse.js for ~50KB. + +import { lock, unlock } from "./scroll-lock.js"; + +let INDEX = null; +let INDEX_LOADING = null; + +const _decodeEl = document.createElement("textarea"); +function decodeEntities(s) { + if (!s || !s.includes("&")) return s; + _decodeEl.innerHTML = s; + return _decodeEl.value; +} + +function decodeEntry(entry) { + const out = {}; + for (const [k, v] of Object.entries(entry)) { + out[k] = typeof v === "string" ? decodeEntities(v) : v; + } + return out; +} + +async function loadIndex() { + if (INDEX) return INDEX; + if (INDEX_LOADING) return INDEX_LOADING; + const url = document.querySelector('meta[name="search-index-url"]')?.content + || "/index.json"; + INDEX_LOADING = fetch(url, { credentials: "same-origin" }) + .then(r => r.ok ? r.json() : []) + .then(data => { INDEX = (Array.isArray(data) ? data : []).map(decodeEntry); return INDEX; }) + .catch(() => { INDEX = []; return INDEX; }); + return INDEX_LOADING; +} + +function tokenize(q) { + return q.toLowerCase().split(/\s+/).filter(Boolean); +} + +function score(entry, terms) { + const haystacks = [ + [entry.title || "", 18], + [entry.linkTitle || "", 12], + [entry.section || "", 6], + [(entry.tags || []).join(" "), 5], + [entry.description || "", 4], + [entry.summary || "", 1], + ]; + let total = 0; + for (const term of terms) { + let termHit = 0; + for (const [text, w] of haystacks) { + const t = text.toLowerCase(); + if (!t) continue; + if (new RegExp("\\b" + escapeRe(term)).test(t)) termHit += w * 2; + else if (t.includes(term)) termHit += w; + } + if (termHit === 0) return 0; + total += termHit; + } + return total; +} + +function escapeRe(s) { return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); } +function escapeHtml(s) { + return String(s).replace(/[&<>"']/g, c => ({ "&":"&","<":"<",">":">",'"':""","'":"'" }[c])); +} + +function highlight(text, terms) { + if (!text) return ""; + let out = escapeHtml(text); + for (const term of terms) { + if (!term) continue; + out = out.replace(new RegExp("(" + escapeRe(term) + ")", "ig"), "$1"); + } + return out; +} + +function search(query, max = 12) { + const terms = tokenize(query); + if (!terms.length) return []; + const scored = []; + for (const entry of INDEX || []) { + const s = score(entry, terms); + if (s > 0) scored.push({ s, entry }); + } + scored.sort((a, b) => b.s - a.s); + return scored.slice(0, max).map(({ entry }) => entry); +} + +function buildModal() { + const root = document.createElement("div"); + root.className = "site-search"; + root.setAttribute("role", "dialog"); + root.setAttribute("aria-modal", "true"); + root.setAttribute("aria-label", "Search"); + root.innerHTML = ` +
+
+ + + esc +
+ + +
+ ↑ ↓ navigate + ↵ select + esc close +
+
`; + document.body.appendChild(root); + return root; +} + +export function initSearch() { + let modal, input, results, empty; + let activeIdx = -1; + let isOpen = false; + let lastResults = []; + let lastTrigger = null; + + const open = (trigger) => { + if (isOpen) return; + if (!modal) { + modal = buildModal(); + input = modal.querySelector(".site-search__input"); + results = modal.querySelector(".site-search__results"); + empty = modal.querySelector(".site-search__empty"); + + input.addEventListener("input", () => onQuery(input.value)); + input.addEventListener("keydown", onKey); + modal.addEventListener("click", (e) => { if (e.target === modal) close(); }); + } + lastTrigger = trigger || document.activeElement; + loadIndex(); + modal.classList.add("is-open"); + input.setAttribute("aria-expanded", "true"); + lock(); + isOpen = true; + setTimeout(() => input.focus(), 30); + }; + + const close = () => { + if (!modal || !isOpen) return; + modal.classList.remove("is-open"); + input.setAttribute("aria-expanded", "false"); + input.removeAttribute("aria-activedescendant"); + unlock(); + isOpen = false; + activeIdx = -1; + if (lastTrigger && typeof lastTrigger.focus === "function") { + lastTrigger.focus(); + } + lastTrigger = null; + }; + + const setActive = (i) => { + const items = results.querySelectorAll(".site-search__result"); + activeIdx = Math.max(0, Math.min(i, items.length - 1)); + items.forEach((el, idx) => { + el.classList.toggle("is-active", idx === activeIdx); + el.setAttribute("aria-selected", idx === activeIdx ? "true" : "false"); + }); + const active = items[activeIdx]; + if (active) { + input.setAttribute("aria-activedescendant", active.id); + active.scrollIntoView({ block: "nearest" }); + } else { + input.removeAttribute("aria-activedescendant"); + } + }; + + const onQuery = (q) => { + const terms = tokenize(q); + lastResults = search(q); + if (!q.trim()) { + results.innerHTML = ""; + empty.hidden = true; + return; + } + if (!lastResults.length) { + results.innerHTML = ""; + empty.hidden = false; + return; + } + empty.hidden = true; + results.innerHTML = lastResults.map((r, i) => ` +
  • + + ${highlight(r.title, terms)} + ${r.section ? `${escapeHtml(r.section)}` : ""} + ${r.description ? `${highlight(r.description, terms)}` : ""} + +
    • `).join(""); + activeIdx = 0; + const first = results.querySelector(".site-search__result"); + if (first) input.setAttribute("aria-activedescendant", first.id); + }; + + const onKey = (e) => { + if (e.key === "Escape") { e.preventDefault(); close(); return; } + if (e.key === "ArrowDown") { e.preventDefault(); setActive(activeIdx + 1); return; } + if (e.key === "ArrowUp") { e.preventDefault(); setActive(activeIdx - 1); return; } + if (e.key === "Enter") { + e.preventDefault(); + const items = results.querySelectorAll(".site-search__result"); + const link = items[activeIdx]; + if (link) { window.location.href = link.href; } + return; + } + if (e.key === "Tab") { e.preventDefault(); } + }; + + // Global triggers + document.querySelectorAll("[data-search-trigger]").forEach(btn => { + btn.addEventListener("click", () => open(btn)); + }); + document.addEventListener("keydown", (e) => { + if (e.target && (e.target.tagName === "INPUT" || e.target.tagName === "TEXTAREA" || e.target.isContentEditable)) return; + if ((e.metaKey || e.ctrlKey) && e.key.toLowerCase() === "k") { + e.preventDefault(); open(); return; + } + if (e.key === "/") { + if (modal && modal.classList.contains("is-open")) return; + e.preventDefault(); open(); return; + } + }); +} diff --git a/config.yaml b/config.yaml deleted file mode 100644 index b651b3b..0000000 --- a/config.yaml +++ /dev/null @@ -1,83 +0,0 @@ -baseURL: 'https://splunk.github.io/splunk-show-docs/' -languageCode: 'en-us' -title: 'Splunk Show Documentation' -theme: 'relearn' - -# URL settings -uglyURLs: false -relativeURLs: false -canonifyURLs: true - -# Relearn theme parameters -params: - # Edit page settings - editPage: true - - # Updated author format (fix for deprecation warning) - author: - name: "Splunk" - - # Cache busting - adds hash to asset URLs - disableAssetsBusting: false - - # Custom asset version (set via HUGO_PARAMS_assetVersion in CI) - assetVersion: "" - - # URL settings - disable explicit index.html in URLs - disableExplicitIndexURLs: true - - # Theme settings - #themeVariant: "auto" # auto, light, dark, blue, green, red - themeVariant: - - identifier: "auto" - name: "Auto" - - identifier: "splunk-light" - name: "Light" - - identifier: "splunk-dark" - name: "Dark" - disableBreadcrumb: false - disableNextPrev: false - disableLandingPageButton: false - titleSeparator: "::" - - # Custom links in menu - additionalContentLanguage: ['en'] - -# Menu configuration -menu: - shortcuts: - - name: "Release Notes (Splunkers only)" - url: "https://splunk.show/release-notes" - weight: 10 - pre: ' ' - - name: "Splunk Show Portal" - url: "https://show.splunk.com" - weight: 20 - pre: ' ' - - name: "Support Slack (Splunkers only)" - url: "https://splunk.enterprise.slack.com/archives/C02EQU3B9HR" - weight: 30 - pre: ' ' - -# Markup settings -markup: - goldmark: - renderer: - unsafe: true - highlight: - lineNos: true - style: "github" - -# Updated output formats (removed unsupported SEARCH and JSON) -outputs: - home: ["HTML", "RSS"] - section: ["HTML", "RSS", "PRINT"] - page: ["HTML", "RSS", "PRINT"] - -outputFormats: - PRINT: - baseName: "index" - isHTML: true - mediaType: "text/html" - path: "_print" - permalinkable: false diff --git a/content/_index.md b/content/_index.md index 898b5db..73fd989 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,35 +1,22 @@ -+++ -title = "Splunk Show Documentation" -description = "A comprehensive user guide for using the Splunk Show platform" -+++ +--- +title: "Splunk Show Documentation" +description: "A comprehensive user guide for using the Splunk Show platform" +--- -welcome -welcome +welcome +welcome diff --git a/content/account-settings/_index.md b/content/account-settings/_index.md index 5a26062..07cca6a 100644 --- a/content/account-settings/_index.md +++ b/content/account-settings/_index.md @@ -1,16 +1,16 @@ -+++ -title = "Account Settings" -weight = 60 -+++ +--- +title: "Account Settings" +weight: 60 +--- Access your user account settings from the user icon in the top right corner of the Splunk Show UI. -my_page +my_page ## Quick Links -- [Preferences](preferences/) - Customize your UI theme, region, timezone, and default schedules -- [Notifications](notifications/) - Set up Slack and email notifications for your instances -- [Salesforce](salesforce/) - Connect your Salesforce account for easier activity tracking +- [Preferences](/account-settings/preferences/) - Customize your UI theme, region, timezone, and default schedules +- [Notifications](/account-settings/notifications/) - Set up Slack and email notifications for your instances +- [Salesforce](/account-settings/salesforce/) - Connect your Salesforce account for easier activity tracking diff --git a/content/account-settings/notifications.md b/content/account-settings/notifications.md index 415c233..60a08f5 100644 --- a/content/account-settings/notifications.md +++ b/content/account-settings/notifications.md @@ -1,7 +1,7 @@ -+++ -title = "Notifications" -weight = 20 -+++ +--- +title: "Notifications" +weight: 20 +--- @@ -14,16 +14,16 @@ To enable Slack and Email notifications, you will need to opt-in within the Splu Under **Email Notifications** click **Enable Email Notifications**. -my_page +my_page By default all notifications are off, but you can opt-in to all of them, or just select the ones you find most relevant. As an example, to be notified a specific amount of time before an instance is stopped, you can click **+ Add Notification** and set the desired amount of time. -my_page +my_page
    - my_page + my_page
    Email notification example
    @@ -33,9 +33,9 @@ As an example, to be notified a specific amount of time before an instance is st Disable notifications at any time by clicking the **Unlink Slack** or **Disable Email Notifications** buttons respectively. -my_page +my_page -my_page +my_page ## Splunk Show Slackbot @@ -43,14 +43,14 @@ Disable notifications at any time by clicking the **Unlink Slack** or **Disable Slack notifications will be sent by the Splunk Show app. -my_page +my_page Two new slash ( `/` ) commands are now supported in Slack: * `/list-demos` - lists the demos you currently have running or scheduled, allowing you to stop, suspend or extend (1 day at a time) your demos, as well as find the enablement materials - all directly from Slack! * `/list-workshops` - provides the same functionality as above, but for workshops.
    - my_page + my_page
    Example of using the /list-workshops command in the Splunk Show Slackbot
    @@ -65,7 +65,7 @@ A notifications icon is now part of the navigation bar and will list interaction Currently this is limited to ownership transfers and stack extension requests, but watch out for further notification types in future!
    - my_page + my_page
    Example of a notification displayed within Splunk Show
    diff --git a/content/account-settings/preferences.md b/content/account-settings/preferences.md index 85c1a90..309f263 100644 --- a/content/account-settings/preferences.md +++ b/content/account-settings/preferences.md @@ -1,14 +1,14 @@ -+++ -title = "Preferences" -weight = 10 -+++ +--- +title: "Preferences" +weight: 10 +--- -my_page +my_page Customize your Splunk Show experience with these preference settings: * **UI theme** - switch between Auto, Dark or Light UI themes -* **Preferred Region** - set the default AWS region that Show will use when you create new demos and workshops. This will only change the default region that is selected - you will still be able to override this when requesting an instance (see [Demo Details](../../demos/creating-demos/#demo-details)). -* **Timezone** - set the default timezone that Show will use when you create new demos and workshops. This will only change the default timezone that is selected - you will still be able to override this when requesting an instance (see [Runtime](../../demos/creating-demos/#runtime)). -* **Scheduled Instances** - set the default running schedule that Show will use when you create new demos and workshops. This will only change the default running schedule that is selected - you will still be able to override this when requesting an instance (see [Runtime](../../demos/creating-demos/#runtime)). +* **Preferred Region** - set the default AWS region that Show will use when you create new demos and workshops. This will only change the default region that is selected - you will still be able to override this when requesting an instance (see [Demo Details](/demos/creating-demos/#demo-details)). +* **Timezone** - set the default timezone that Show will use when you create new demos and workshops. This will only change the default timezone that is selected - you will still be able to override this when requesting an instance (see [Runtime](/demos/creating-demos/#runtime)). +* **Scheduled Instances** - set the default running schedule that Show will use when you create new demos and workshops. This will only change the default running schedule that is selected - you will still be able to override this when requesting an instance (see [Runtime](/demos/creating-demos/#runtime)). diff --git a/content/account-settings/salesforce.md b/content/account-settings/salesforce.md index 2aa71a3..671aa4e 100644 --- a/content/account-settings/salesforce.md +++ b/content/account-settings/salesforce.md @@ -1,7 +1,7 @@ -+++ -title = "Salesforce Integration" -weight = 30 -+++ +--- +title: "Salesforce Integration" +weight: 30 +--- @@ -10,7 +10,7 @@ weight = 30 Under **Account Settings** click on the **Salesforce** tab and click the **Connect to Salesforce** button. This will leverage a Connected App and log in to Salesforce using your Okta credentials. When complete, you will be redirected to Splunk Show. That's it! You are now connected.
    - my_page + my_page
    Salesforce integration settings
    @@ -24,7 +24,7 @@ If you see an error message when connecting to Salesforce, this likely means you Once you are connected to Salesforce, you will see an additional search option when creating a demo or workshop. Previously, Splunk Show required that you provide the SFDC record ID; if you still prefer that workflow you can still manually enter/paste the ID as before and Splunk Show will search the record in Salesforce, pulling back the name and type of record.
    - my_page + my_page
    Select Salesforce as your use case when possible
    @@ -34,13 +34,13 @@ Alternatively, **you can now search Salesforce records directly**, by clicking o
    - Grouped Resources 1 + Grouped Resources 1
    Use the in-built search to find a Salesforce record if you don't know the ID
    - Grouped Resources 2 + Grouped Resources 2
    Example of a Salesforce ID being populated by the advanced search
    diff --git a/content/catalog/_index.md b/content/catalog/_index.md index 131c74c..699c59b 100644 --- a/content/catalog/_index.md +++ b/content/catalog/_index.md @@ -1,14 +1,14 @@ -+++ -title = "Catalog Page" -weight = 20 -+++ +--- +title: "Catalog Page" +weight: 20 +--- -my_page +my_page The Catalog page provides a tabular view of all content that you have access to in Splunk Show. -my_page +my_page * **Search** field - Simply type key words to quickly and dynamically filter the list. @@ -16,30 +16,30 @@ The Catalog page provides a tabular view of all content that you have access to
    * **Type** dropdown - Filter by type of content, such as demos or workshops - my_page + my_page * **Request** dropdown - Filter by the type of request, such as on-demand demos, always on demos (formerly called "static demos") or shared demos. - my_page + my_page * **Updated** dropdown - Use this to filter by content that was recently updated, such as the last 30 days. - my_page + my_page * **More filters** - Provides an additional set of filters to help you further refine the results. - my_page + my_page {{% notice info %}} **Shared Demos** -For more information on leveraging shared demos please see [Shared Demos](../demos/shared-demos/). +For more information on leveraging shared demos please see [Shared Demos](/demos/shared-demos/). {{% /notice %}} {{% notice info %}} **Always-On Demos** -For more information on using always on demos please see [Always-On Demos](../demos/always-on-demos/). +For more information on using always on demos please see [Always-On Demos](/demos/always-on-demos/). {{% /notice %}} Click on any row in the table to view a quick summary of the content, with options to **launch an instance**, view **more information** (which takes you to the full template page) or to **copy a link** to that template (good for sharing!)
    - my_page + my_page
    Clicking on a row in the catalog shows an quick view of the content with key information
    diff --git a/content/demos/_index.md b/content/demos/_index.md index 47e314a..3be936e 100644 --- a/content/demos/_index.md +++ b/content/demos/_index.md @@ -1,13 +1,13 @@ -+++ -title = "Demos" -weight = 30 -+++ +--- +title: "Demos" +weight: 30 +--- Learn how to create and manage demo instances in Splunk Show. This section covers: -- [Creating Demos](creating-demos/) - Request and configure new demo instances -- [Managing Demos](managing-demos/) - Control, extend, and maintain your running demos -- [Always On Demos](always-on-demos/) - Access shared, always-running demo environments -- [Shared Demos](shared-demos/) - Use and share on-demand demos with others +- [Creating Demos](/demos/creating-demos/) - Request and configure new demo instances +- [Managing Demos](/demos/managing-demos/) - Control, extend, and maintain your running demos +- [Always On Demos](/demos/always-on-demos/) - Access shared, always-running demo environments +- [Shared Demos](/demos/shared-demos/) - Use and share on-demand demos with others diff --git a/content/demos/always-on-demos.md b/content/demos/always-on-demos.md index e6fd7ec..7e14f1e 100644 --- a/content/demos/always-on-demos.md +++ b/content/demos/always-on-demos.md @@ -1,14 +1,14 @@ -+++ -title = "Always-On (Static) Demos" -weight = 30 -+++ +--- +title: "Always-On (Static) Demos" +weight: 30 +--- Always on (formerly "static") demo instances are environments that are always running and can be accessed immediately. You can view the list of always on demos from the **Catalog** page by filtering for "Always On" demos.
    - Use the Request filter to view only always on demos + Use the Request filter to view only always on demos
    Use the Request filter to view only always on demos
    @@ -16,20 +16,20 @@ Always on (formerly "static") demo instances are environments that are always ru {{% notice note %}} **User Permissions for Always On Demos** -Since always on demos are shared environments, user permissions are typically restricted to prevent accidental changes that could impact other users. If you need to make changes or customise a demo in any way you should leverage an on-demand demo (see [Creating Demos](../creating-demos/).) +Since always on demos are shared environments, user permissions are typically restricted to prevent accidental changes that could impact other users. If you need to make changes or customise a demo in any way you should leverage an on-demand demo (see [Creating Demos](/demos/creating-demos/).) {{% /notice %}} -To access an always on demo, click on the demo. You will need to add at least one activity before the connection details become available to you. Click on either **Add activity** or **+ New activity** at the bottom of the page to add an activity and reveal the connection information (see [Creating Demos](../creating-demos/#use-case) for information on the activity types.) +To access an always on demo, click on the demo. You will need to add at least one activity before the connection details become available to you. Click on either **Add activity** or **+ New activity** at the bottom of the page to add an activity and reveal the connection information (see [Creating Demos](/demos/creating-demos/#use-case) for information on the activity types.)
    - Example of blurred connection information on an always on demo + Example of blurred connection information on an always on demo
    Example of blurred connection information on an always on demo
    - Connection information is revealed when you add an activity + Connection information is revealed when you add an activity
    Connection information is revealed when you add an activity
    diff --git a/content/demos/creating-demos.md b/content/demos/creating-demos.md index 6c0a412..f90ee3b 100644 --- a/content/demos/creating-demos.md +++ b/content/demos/creating-demos.md @@ -1,7 +1,7 @@ -+++ -title = "Creating a Demo" -weight = 10 -+++ +--- +title: "Creating a Demo" +weight: 10 +--- @@ -12,13 +12,13 @@ When you click on the **New demo** button for a demo template you are taken to t {{% /notice %}} ## New demo -my_page +my_page * **Name** - the customizable name of the demo instance * **Custom notes** - a free text field for any internal notes related to this demo ## Use Case -my_page +my_page The reason for the demo instance, which has several options (Please expand the section relevant to your role):: @@ -26,15 +26,15 @@ The reason for the demo instance, which has several options (Please expand the s * **Type**
    - my_page + my_page
    Options available to Splunkers
    - * **Salesforce** - the instance is being spun up for a customer-facing activity related to one of the following Salesforce entities. Please use this option when possible as it helps the team to track the demo instance spend to a specific Salesforce record. Either paste in the SFDC ID for the Account, Opportunity, Campaign, or SESR/INH the workshop will be tied to, or alternatively use the **Advanced search** option to search by name. For more detailed information, see the [Salesforce Integration](../../account-settings/salesforce/) section. + * **Salesforce** - the instance is being spun up for a customer-facing activity related to one of the following Salesforce entities. Please use this option when possible as it helps the team to track the demo instance spend to a specific Salesforce record. Either paste in the SFDC ID for the Account, Opportunity, Campaign, or SESR/INH the workshop will be tied to, or alternatively use the **Advanced search** option to search by name. For more detailed information, see the [Salesforce Integration](/account-settings/salesforce/) section.
    - my_page + my_page
    Available SFDC record types when using the Advanced search
    @@ -58,14 +58,14 @@ The reason for the demo instance, which has several options (Please expand the s * **Type**
    - my_page + my_page
    Options available to partners
    * **Salesforce** - the demo is being spun up for a customer-facing activity related to one of the following Salesforce entities. Please use this option when possible as it helps the team to tie content usage to a specific customer. - my_page + my_page * **ID Type** * Account @@ -79,7 +79,7 @@ The reason for the demo instance, which has several options (Please expand the s {{% /expand %}} ## Network - my_page + my_page * **SSH access** -Splunkers Only (only available on some Some Enterprise based templates) this option allows you to enable SSH access to the instance. Once enabled, the SSH access information will be available under the instance details alongside your Splunk login credentials. @@ -94,13 +94,13 @@ The reason for the demo instance, which has several options (Please expand the s {{% /notice %}} ## Runtime - my_page + my_page Provides options to customise the running schedule for your instance(s). Options include: * **Schedule** - select whether you want your demo to be spun up
    - my_page + my_page
    Options available when scheduling an instance
    @@ -119,7 +119,7 @@ Provides options to customise the running schedule for your instance(s). Options {{% /notice %}} * **Operating hours** - (can only be changed on Splunk Enterprise based templates) this allows you to create a custom schedule for the instance, selecting the days and time window you would like to have the instance available. Once selected, Splunk Show will automatically pause/restart the instance at the scheduled time. - my_page + my_page {{% notice info %}} **Splunk Cloud based templates** @@ -131,7 +131,7 @@ Provides options to customise the running schedule for your instance(s). Options * **User default operating hours** - Within Account Settings > Preferences > Scheduled Instances, there is a place to set a user-defined schedule if you operate outside of typical business hours, or have use cases that require different time windows. * **Custom operating hours** - this option is to set a schedule for that specific instance in cases where a one-off schedule is required.
    - my_page + my_page
    Example of using ‘Custom operating hours’
    @@ -146,9 +146,9 @@ Provides options to customise the running schedule for your instance(s). Options Splunk Show displays time in either 12 or 24 hour format, according to your OS and browser settings. If you wish to change from one format to another please adjust these settings in your OS/browser. ## Demo Details -my_page +my_page -* **Shared demo** - select whether this demo will be shared with other Splunk Show users. Enabling this will make this demo visible to all Splunk Show users under the **Shared** demos section. (see [Shared Demos](../shared-demos/)). If your demo has been linked to a Salesforce record and you toggle this Shared demo switch on, an advisory message will appear warning you that this is not recommended due to potential impact to customer activities. You can continue with sharing but at your own risk. +* **Shared demo** - select whether this demo will be shared with other Splunk Show users. Enabling this will make this demo visible to all Splunk Show users under the **Shared** demos section. (see [Shared Demos](/demos/shared-demos/)). If your demo has been linked to a Salesforce record and you toggle this Shared demo switch on, an advisory message will appear warning you that this is not recommended due to potential impact to customer activities. You can continue with sharing but at your own risk. {{% notice info %}} **Shared Demos** diff --git a/content/demos/managing-demos.md b/content/demos/managing-demos.md index c7e3dec..efe2ab7 100644 --- a/content/demos/managing-demos.md +++ b/content/demos/managing-demos.md @@ -1,14 +1,14 @@ -+++ -title = "Managing a Demo" -weight = 20 -+++ +--- +title: "Managing a Demo" +weight: 20 +--- To manage a demo, locate the requested demo on the home page under **My instances** and click on the requested demo.
    - Click on a demo to access the management view + Click on a demo to access the management view
    Click on a demo to access the management view
    @@ -17,7 +17,7 @@ To manage a demo, locate the requested demo on the home page under **My instance You will be presented with the management page for your demo.
    - Example of a management page for a running demo + Example of a management page for a running demo
    Example of a management page for a running demo
    @@ -36,12 +36,12 @@ Much of this page is self explanatory but please note the following options: - [Access Connection Info](#accessing-demo-connection-information) ## Extend Instances (Change lifetime) -my_page +my_page Extend an instance by using the **Change lifetime** option. When extending instances, the status of the demo/workshop will briefly change to PENDING while the lifetime value is updated, and will return to the RUNNING state when the extension is complete.
    - Select a new termination date for your instances using the Change lifetime option + Select a new termination date for your instances using the Change lifetime option
    Select a new termination date for your instances using the Change lifetime option
    @@ -57,14 +57,14 @@ Cloud-based demos - such as those which leverage Splunk Cloud Platform, SOAR or {{% /notice %}} ## Pause Instances -my_page +my_page (Only available for Splunk Enterprise instances) Use the **Pause** option to temporarily pause the instance(s). This will put the demo into a SUSPENDED state. When suspended, the instance is taken offline and will not be accessible until it is restarted. This is particularly useful in cases where demos or workshops don't complete in the initial meeting and are required for a follow-up, but aren't needed in between. A great use case here would be for running customer workshops where only part of the work gets completed. The instances can be suspended and then restarted when it is time to meet with the customer again. ## Resume a Paused Instance -my_page +my_page When a demo instance is paused (i.e. a "SUSPENDED" state) the **Pause** option will be replaced with a **Resume** option. Click on this button to unpause/resume your demo. Doing so will override the runtime schedule that you set for your demo and will bring your instance back online. Note that Show will still pause/suspend your instance when it reaches the next suspend time as outlined in your runtime schedule. @@ -85,26 +85,26 @@ A paused instance only incurs a minimal cost for the storage volume, saving 99% {{% /notice %}} ## Reboot Instances -my_page +my_page (Only available for Splunk Enterprise instances) Splunk Enterprise-based demo instances can be rebooted at any point from the moment you request them. This applies to both the provisioning process (i.e. if the stacks errors out or is stuck in STARTING for a long time) and also if the instance is already RUNNING but has become unresponsive. To reboot a demo instance navigate to the demo's management page and click **Reboot**. ## Transfer Ownership -my_page +my_page You can transfer the ownership of a demo or workshop instance to another user of Splunk Show. A transfer request is then sent to the requested new owner where they can accept or reject the transfer.
    - Enter the new user's email to transfer ownership + Enter the new user's email to transfer ownership
    Enter the new user’s email to transfer ownership
    ## Add More Data Sources to Your Demo (Data Bundles) -my_page +my_page Data bundles are datasets that you can add to your demo instance. Examples include: @@ -126,20 +126,20 @@ Instances must be in a RUNNING state to access the **+ Add data bundles** option {{% /notice %}}
    - my_page + my_page
    Example of adding data bundles to a RUNNING demo instance
    * **Test HEC connection** - click this button to test the preconfigured HEC endpoint and token. A green tick will appear to indicate that HEC is configured and working. -my_page +my_page * **Advance configuration** - click this button to view HEC information and customisation options
    - my_page + my_page
    Viewing HEC advanced configuration options
    @@ -153,7 +153,7 @@ Instances must be in a RUNNING state to access the **+ Add data bundles** option Type keywords into the search bar to search the available data bundles.
    - my_page + my_page
    Data bundle keyword search
    @@ -161,7 +161,7 @@ Instances must be in a RUNNING state to access the **+ Add data bundles** option Click on a data bundle tile to view detailed information about app dependencies and any additional setup required, such as any indexes you need to create. Be sure to follow these instructions to ensure that the data onboards correctly!
    - my_page + my_page
    Example of a data bundle, containing setup information
    @@ -170,7 +170,7 @@ Instances must be in a RUNNING state to access the **+ Add data bundles** option **App dependencies** - click on **Install** to view the app within Splunk's native app installation view.
    - my_page + my_page
    BClicking on ‘Install’ for an app dependency will take you to your Splunk instance and populate the app in the search box
    @@ -180,8 +180,8 @@ Click on **View on Splunkbase** to navigate to the app's Splunkbase page where y To activate a data bundle, toggle the **Activate** check box on the tile and click the **Activate x datasets** button in the top right to apply your changes.
    - Grouped Resources 1 - Grouped Resources 2 + Grouped Resources 1 + Grouped Resources 2
    {{% notice info %}} @@ -201,7 +201,7 @@ Check the details for each data bundle when activating it to make sure you have When you add one or more data bundles to a demo you will see a **Data Sources** section on the management page for your demo.
    - my_page + my_page
    A Data Sources section is added to your demo page when you add data bundles
    @@ -219,7 +219,7 @@ If you need to edit a data bundle - such as to change the HEC token information Locate the requested demo you need to access on the home page under **My instances** and click on the demo. This will bring up the demo management page. Scroll down to the **Connection** or **Instances** section to view the connection URLs, usernames and passwords for your demo.
    - my_page + my_page
    Example of connection information for a demo instance
    @@ -229,13 +229,13 @@ For demos that feature multiple instances, this section will be called **Instanc
    - Grouped Resources 1 + Grouped Resources 1
    Example of a demo with multiple instances
    - Grouped Resources 2 + Grouped Resources 2
    In a demo with multiple instances, click on the tile to view connection information for that instance
    diff --git a/content/demos/shared-demos.md b/content/demos/shared-demos.md index d5e7400..f5f08d8 100644 --- a/content/demos/shared-demos.md +++ b/content/demos/shared-demos.md @@ -1,11 +1,11 @@ -+++ -title = "Shared Demos" -weight = 40 -+++ +--- +title: "Shared Demos" +weight: 40 +--- -Shared demos are on-demand demo instances that requestors have marked as "shared" (see [Creating Demos](../creating-demos/#demo-details).) This option provides users with quick access to provisioned demos where you would otherwise have to wait for the instance to provision. +Shared demos are on-demand demo instances that requestors have marked as "shared" (see [Creating Demos](/demos/creating-demos/#demo-details).) This option provides users with quick access to provisioned demos where you would otherwise have to wait for the instance to provision. You can find shared demos on the **Catalog** page by filtering for 'Shared Demo'. @@ -13,11 +13,11 @@ You can find shared demos on the **Catalog** page by filtering for 'Shared Demo' **Shared Demo Best Practices** As a best practice, **do not modify the content of shared demos**. Since any number of users may be leveraging the demo at any given time, it is best to keep it as standard as possible. -If you need to customise the demo content for a customer, you should request a new instance (see [Creating Demos](../creating-demos/).) +If you need to customise the demo content for a customer, you should request a new instance (see [Creating Demos](/demos/creating-demos/).) {{% /notice %}}
    - Example of shared demos displayed on the filtered Catalog page + Example of shared demos displayed on the filtered Catalog page
    Example of shared demos displayed on the filtered Catalog page
    @@ -25,19 +25,19 @@ If you need to customise the demo content for a customer, you should request a n To leverage a shared demo, click on the demo and add an activity to reveal the user credentials for the instance. -my_page +my_page Connection information is displayed once you add an activity.
    - Example of blurred connection information on a shared demo + Example of blurred connection information on a shared demo
    Example of blurred connection information on a shared demo
    - Connection information is revealed when you add an activity + Connection information is revealed when you add an activity
    Connection information is revealed when you add an activity
    diff --git a/content/finding-content/_index.md b/content/finding-content/_index.md index 79d2a3c..be42892 100644 --- a/content/finding-content/_index.md +++ b/content/finding-content/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Finding Content" -weight = 15 -+++ +--- +title: "Finding Content" +weight: 15 +--- @@ -11,7 +11,7 @@ The easiest way to find content is via the [Catalog page](/catalog/). However, t Click on the **+ New Instance** button at the top of the Splunk Show home page and you will be taken to the **Select a template** page.
    - Filter options when searching templates + Filter options when searching templates
    Filter options when searching templates
    @@ -24,18 +24,18 @@ Use the filters at the top of the page to filter the template view depending on * **Workshop templates** - view only workshops * **Any product area** - filter by product area (security, observability or platform)
    - my_page + my_page
    * **Any environment** - filter by the type of demo/workshop environment (Splunk Cloud, Splunk Enterprise or Hybrid which means a mixture of two or more environment types)
    - my_page + my_page
    * **Search bar** - enter keywords to search the template titles, descriptions and other properties, such as installed apps.
    - Example of search results when searching templates + Example of search results when searching templates
    Example of search results when searching templates
    diff --git a/content/finding-content/view-template-information.md b/content/finding-content/view-template-information.md index 8b3da44..4f636f3 100644 --- a/content/finding-content/view-template-information.md +++ b/content/finding-content/view-template-information.md @@ -1,14 +1,14 @@ -+++ -title = "View Template Information" -weight = 10 -+++ +--- +title: "View Template Information" +weight: 10 +--- Click on a template tile (not the 'New…' button but the tile itself) to view information about that template.
    - my_page + my_page
    Example of information presented when viewing a template. Note: Not all possible template metadata is shown in this screenshot
    @@ -21,7 +21,7 @@ Click on a template tile (not the 'New…' button but the tile itself) to view i **Instructions** - (only displayed in some templates) outlines any additional instructions that you should know about this template, such as how long data backfill takes to complete before your demo is fully ready to use.
    - my_page + my_page
    Example of additional instructions included in a demo template. Note: Not all templates include this section
    @@ -34,13 +34,13 @@ Click on a template tile (not the 'New…' button but the tile itself) to view i
    - Grouped Resources 1 + Grouped Resources 1
    Grouped resources example 1
    - Grouped Resources 2 + Grouped Resources 2
    Grouped resources example 2
    @@ -64,5 +64,5 @@ If this button is linked to a Google Drive folder you will see a popup with a li {{% notice warning %}} **Experiencing Technical Issues with a Show Instance?** The Submit Content Feedback button should only be used for content improvement feedback. -If you are experiencing technical issues related to the running of a Splunk Show demo/workshop - such as instances not spinning up or data not appearing in a specific instance - please raise a support request (see [Support](../../support/).) +If you are experiencing technical issues related to the running of a Splunk Show demo/workshop - such as instances not spinning up or data not appearing in a specific instance - please raise a support request (see [Support](/support/).) {{% /notice %}} diff --git a/content/my-page/_index.md b/content/my-page/_index.md index 9d97e12..6889267 100644 --- a/content/my-page/_index.md +++ b/content/my-page/_index.md @@ -1,12 +1,12 @@ -+++ -title = "My Page" -weight = 10 -+++ +--- +title: "My Page" +weight: 10 +--- - -My Page + +My Page By default, you will land on your personal home page. This page presents an overview of your Show usage. @@ -19,7 +19,7 @@ If you don't see any of these tabs this means you haven't yet been granted acces * **Search bar** - use this to search for any content in Splunk Show. Results will include both demo/workshop templates as well as past and current instances you have requested. - Example of searching using the search bar + Example of searching using the search bar
    Example of searching using the search bar
    @@ -27,14 +27,14 @@ If you don't see any of these tabs this means you haven't yet been granted acces * **+ New Instance** button - takes you to the **Select a template** page to browse all Show demo/workshop templates * **Overview** - includes key statistics about your Splunk Show usage - my_page + my_page -* **My instances** - provides a quick view of your currently running Show instances with the ability to filter by only demos, workshops or events. Click on the **Actions** button on any of the listed instances for quick access to common management tasks for your demo/workshop/event (see [Managing Demos](../demos/managing-demos/) for more information on these actions.) +* **My instances** - provides a quick view of your currently running Show instances with the ability to filter by only demos, workshops or events. Click on the **Actions** button on any of the listed instances for quick access to common management tasks for your demo/workshop/event (see [Managing Demos](/demos/managing-demos/) for more information on these actions.) - my_page + my_page * **Quick launch** - provides a quick view of the available templates (i.e. demos and workshops) in alphabetical order with the option to filter. Scroll left and right by clicking on the white directional arrows. Any templates that have added as a 'Favorite' will be listed first in this list. - my_page + my_page For a full list of templates click on **+ New Instance** at the top of the page. diff --git a/content/public-page/_index.md b/content/public-page/_index.md index e90c076..b3e2fbe 100644 --- a/content/public-page/_index.md +++ b/content/public-page/_index.md @@ -1,14 +1,14 @@ -+++ -title = "Public Page" -weight = 50 -+++ +--- +title: "Public Page" +weight: 50 +--- -my_page +my_page This page provides the default public view for all customers who log in to Splunk Show. -my_page +my_page The Public page contains the following: diff --git a/content/signing-in/_index.md b/content/signing-in/_index.md index 16dc982..e60fecf 100644 --- a/content/signing-in/_index.md +++ b/content/signing-in/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Signing In" -weight = 5 -+++ +--- +title: "Signing In" +weight: 5 +--- diff --git a/content/support/_index.md b/content/support/_index.md index cdec8fb..3542e9c 100644 --- a/content/support/_index.md +++ b/content/support/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Get Support" -weight = 70 -+++ +--- +title: "Get Support" +weight: 70 +--- @@ -9,6 +9,6 @@ Get help when you need it with Splunk Show. ## Quick Links -- [Infrastructure Issues](infrastructure/) - Report technical problems with the platform -- [Content Feedback](content-feedback/) - Submit feedback about demo/workshop content -- [Feature Requests](feature-requests/) - Suggest improvements to Splunk Show +- [Infrastructure Issues](/support/infrastructure/) - Report technical problems with the platform +- [Content Feedback](/support/content-feedback/) - Submit feedback about demo/workshop content +- [Feature Requests](/support/feature-requests/) - Suggest improvements to Splunk Show diff --git a/content/support/content-feedback.md b/content/support/content-feedback.md index e7fc3d3..1f81c21 100644 --- a/content/support/content-feedback.md +++ b/content/support/content-feedback.md @@ -1,14 +1,14 @@ -+++ -title = "Submit Content Feedback" -weight = 20 -+++ +--- +title: "Submit Content Feedback" +weight: 20 +--- If you have a question or issue with demo/workshop content - e.g. "the demo script has incorrect screenshots" or "the slide deck has a mistake on it", etc. - you can submit content feedback directly to the content owner by clicking into any demo or workshop template and clicking on the **Submit Content Feedback** button.
    - Submit Content Feedback button + Submit Content Feedback button
    Submit Content Feedback button
    @@ -17,7 +17,7 @@ If you have a question or issue with demo/workshop content - e.g. "the demo scri On the popup **Send Feedback** window, enter your content feedback and click on **Send** to submit it to the content owner.
    - Please provide a brief description of the content issue you found + Please provide a brief description of the content issue you found
    Please provide a brief description of the content issue you found
    @@ -25,5 +25,5 @@ On the popup **Send Feedback** window, enter your content feedback and click on {{% notice note %}} **Got a Technical Issue with a Running Instance?** -Technical issues related to the running of your demo/workshop - such as instances not spinning up or data not appearing in a specific instance - should be raised as a support request (see [Infrastructure Issues](../infrastructure/).) +Technical issues related to the running of your demo/workshop - such as instances not spinning up or data not appearing in a specific instance - should be raised as a support request (see [Infrastructure Issues](/support/infrastructure/).) {{% /notice %}} \ No newline at end of file diff --git a/content/support/feature-requests.md b/content/support/feature-requests.md index d7bb0fd..12d20ab 100644 --- a/content/support/feature-requests.md +++ b/content/support/feature-requests.md @@ -1,7 +1,7 @@ -+++ -title = "Feature Requests" -weight = 30 -+++ +--- +title: "Feature Requests" +weight: 30 +--- diff --git a/content/support/infrastructure.md b/content/support/infrastructure.md index 9295f07..4863925 100644 --- a/content/support/infrastructure.md +++ b/content/support/infrastructure.md @@ -1,7 +1,7 @@ -+++ -title = "Infrastructure Issues" -weight = 10 -+++ +--- +title: "Infrastructure Issues" +weight: 10 +--- @@ -14,18 +14,18 @@ While you can post a message in the web chat at any time, the chat is currently {{% notice info %}} **Got an Issue with Demo/Workshop Content?** -If you have a question or issue with demo/workshop content (e.g. "the demo script has incorrect screenshots" or "the slide deck has a mistake on it", etc.) please see [Content Feedback](../content-feedback/). +If you have a question or issue with demo/workshop content (e.g. "the demo script has incorrect screenshots" or "the slide deck has a mistake on it", etc.) please see [Content Feedback](/support/content-feedback/). {{% /notice %}}
    - Use the web chat to get help + Use the web chat to get help
    Use the web chat to get help
    - Type a message to chat with the Splunk Show team! + Type a message to chat with the Splunk Show team!
    Type a message to chat with the Splunk Show team!
    diff --git a/content/workshops/_index.md b/content/workshops/_index.md index 990d01f..2480d36 100644 --- a/content/workshops/_index.md +++ b/content/workshops/_index.md @@ -1,13 +1,13 @@ -+++ -title = "Workshops/Events" -weight = 40 -+++ +--- +title: "Workshops/Events" +weight: 40 +--- Learn how to create and manage workshop instances and events in Splunk Show. This section covers: -- [Creating a Workshop/Event](creating-workshops/) - Creating workshops and events -- [Managing Normal Workshops](managing-workshops/) - Manage 'normal' workshops in Splunk Show -- [Managing Workshop Events](manage-events/) - Manage workshop events with participant enrollment -- [Event Quick Start Guide](event-quick-start/) - Quick reference guide for creating and managing workshop events +- [Creating a Workshop/Event](/workshops/creating-workshops/) - Creating workshops and events +- [Managing Normal Workshops](/workshops/managing-workshops/) - Manage 'normal' workshops in Splunk Show +- [Managing Workshop Events](/workshops/manage-events/) - Manage workshop events with participant enrollment +- [Event Quick Start Guide](/workshops/event-quick-start/) - Quick reference guide for creating and managing workshop events diff --git a/content/workshops/creating-workshops.md b/content/workshops/creating-workshops.md index 8228b00..8063890 100644 --- a/content/workshops/creating-workshops.md +++ b/content/workshops/creating-workshops.md @@ -1,7 +1,7 @@ -+++ -title = "Creating a Workshop/Event" -weight = 10 -+++ +--- +title: "Creating a Workshop/Event" +weight: 10 +--- @@ -17,7 +17,7 @@ When you click on the **New workshop** button for a workshop template you are ta ## New workshop or event -my_page +my_page * **Name** - the customisable name of the demo instance * **Custom notes** - a free text field for any notes related to this workshop (URLs will be detected and made clickable). If you're creating a workshop event then these notes will be visible to enrolled users on the events page. @@ -27,7 +27,7 @@ When you click on the **New workshop** button for a workshop template you are ta {{% /notice %}}
    - Example of what workshop attendees will see when you add a custom note to an event + Example of what workshop attendees will see when you add a custom note to an event
    Example of what workshop attendees will see when you add a custom note to an event
    @@ -36,23 +36,23 @@ When you click on the **New workshop** button for a workshop template you are ta ## Use Case The reason for the workshop, which has the following options (Please expand the section relevant to your role): -my_page +my_page {{% expand title="Splunker Options" %}} * **Type**
    - Options available to Splunkers + Options available to Splunkers
    Options available to Splunkers
    -* **Salesforce** - the workshop is being spun up for a customer-facing activity related to one of the following Salesforce entities. Please use this option when possible as it helps the team to track the demo instance spend to a specific Salesforce record. Either paste in the SFDC ID for the Account, Opportunity, Campaign, or SESR/INH the workshop will be tied to or alternatively use the **Advanced search** option to search by name. For more detailed information, see the [Salesforce Integration](../../account-settings/salesforce/) section. +* **Salesforce** - the workshop is being spun up for a customer-facing activity related to one of the following Salesforce entities. Please use this option when possible as it helps the team to track the demo instance spend to a specific Salesforce record. Either paste in the SFDC ID for the Account, Opportunity, Campaign, or SESR/INH the workshop will be tied to or alternatively use the **Advanced search** option to search by name. For more detailed information, see the [Salesforce Integration](/account-settings/salesforce/) section.
    - Available SFDC record types when using the Advanced search + Available SFDC record types when using the Advanced search
    Available SFDC record types when using the Advanced search
    @@ -75,7 +75,7 @@ The reason for the workshop, which has the following options (Please expand the * **Type**
    - Options available to partners + Options available to partners
    Options available to partners
    @@ -83,7 +83,7 @@ The reason for the workshop, which has the following options (Please expand the * **Salesforce** - the workshop is being spun up for a customer-facing activity related to one of the following Salesforce entities. Please use this option when possible as it helps the team to tie content usage to a specific customer. - my_page + my_page * **ID Type** * Account @@ -98,7 +98,7 @@ The reason for the workshop, which has the following options (Please expand the ## Network -my_page +my_page * **DNS Prefix** - a customisable label that will be included in the DNS records and instance URLs for this workshop. This helps organize the instance URLs once provisioned. For example, entering `abc` as the prefix will result in instance URLs that looks like this: `https://abc-i-08115630654cebf93.splunk.show` @@ -106,7 +106,7 @@ The reason for the workshop, which has the following options (Please expand the ## Runtime -my_page +my_page * **Lifetime** - the Time-to-Live (TTL) for your workshop instances (minimum of 2 hours, maximum of 14 days.) @@ -114,7 +114,7 @@ The reason for the workshop, which has the following options (Please expand the * **Operating hours** - (can only be changed on Splunk Enterprise based templates) this allows you to create a custom schedule for the instance, selecting the days and time window you would like to have the instance available. Once selected, Splunk Show will automatically pause/restart the instance at the scheduled time. - my_page + my_page The available time window selections are: @@ -131,7 +131,7 @@ Splunk Cloud instances must run 24/7 and their operating hours cannot be customi ## Template fields
    - Template fields + Template fields
    Template fields
    @@ -143,13 +143,13 @@ Splunk Show Workshop monitor provides a quick view into your workshop instances {{% notice info %}} **Using Workshop Monitor** -For more information on this feature please see [Monitoring Workshop Instances](../managing-workshops/#monitoring-workshop-instances) +For more information on this feature please see [Monitoring Workshop Instances](/workshops/managing-workshops/#monitoring-workshop-instances) {{% /notice %}} ## Workshop type
    - There are three workshop types available in Show + There are three workshop types available in Show
    There are three workshop types available in Show
    @@ -159,9 +159,9 @@ This section allows you select what type of workshop you want to run. The follow * **Normal** - my_page + my_page - A "traditional" workshop where you request a specific number of workshop instances up front. No Splunk.com account is required. Once provisioned, instance details and access information must be [downloaded as a csv file](../managing-workshops/#obtain-a-list-of-instances-for-a-normal-workshop) for distribution to participants of the workshop. No record of participants is kept by Show (as there is no enrolment) - it's all down to you! + A "traditional" workshop where you request a specific number of workshop instances up front. No Splunk.com account is required. Once provisioned, instance details and access information must be [downloaded as a csv file](/workshops/managing-workshops/#obtain-a-list-of-instances-for-a-normal-workshop) for distribution to participants of the workshop. No record of participants is kept by Show (as there is no enrolment) - it's all down to you! {{% notice tip %}} **Ideal for:** "Old school" workshops where you're happy to manually manage instances and hand out credentials to participants. @@ -169,7 +169,7 @@ This section allows you select what type of workshop you want to run. The follow * **Private Event** - my_page + my_page A workshop that allows you to invite participants to an 'event' within Splunk Show. A Splunk.com account is required. Enable 'Allow anonymous Enrolment via Passcode' at the bottom of the *Create workshop* if you need to allow users to enrol without a Splunk.com account. Invited participants can either use a direct link to access and enrol in the workshop event or you can invite them individually via their email address. When you use the email invite method invitees will receive an email to enrol in the event. You will also get a CSV list of enrolled users at the end of the workshop. @@ -181,7 +181,7 @@ This section allows you select what type of workshop you want to run. The follow * **Public Event** - my_page + my_page Similar to private events but requires no invitation as anyone who logs in to Splunk Show (using a Splunk.com account) can see and enrol in the workshop event. A Splunk.com account is required. Enable 'Allow anonymous Enrolment via Passcode' at the bottom of the *Create workshop* page if you need to allow users to enrol without a Splunk.com account. You will also get a CSV list of enrolled users at the end of the workshop (passcode authenticated users will appear as anonymous users. @@ -196,7 +196,7 @@ This section allows you select what type of workshop you want to run. The follow **Splunkers:** If customers have followed the registration best practices above and still experience registration messages such as the one in the screenshot below please reach out to #dpl-screening-issues in Slack for support.
    - Example screening message during a splunk.com account registration + Example screening message during a splunk.com account registration
    Example screening message during a splunk.com account registration
    @@ -207,11 +207,11 @@ This section allows you select what type of workshop you want to run. The follow {{% expand title="Choosing a Workshop Type" %}} Follow this flow to decide which workshop format is best for your activity: - ![decision flow](/images/show_workshop_decision_flow.png) + ![decision flow](/splunk-show-docs/images/show_workshop_decision_flow.png) {{% /expand %}} ### Provisioning time -my_page +my_page * **Provisioning Start** - the date/time when the instances should be provisioned by the system. Consider the number of instances and average provisioning time for the given template when selecting how far in advance you want the provisioning to start. * **Now** - your instance(s) will be provisioned immediately @@ -242,7 +242,7 @@ This section allows you select what type of workshop you want to run. The follow When attendees enrol in a Splunk Show event they are allocated a workshop instance. The Termination Time setting will only impact users who **don't** enrol. {{% /notice %}}
    - Set how long you want unallocated instances to run for before Show terminates them + Set how long you want unallocated instances to run for before Show terminates them
    Set how long you want unallocated instances to run for before Show terminates them
    @@ -252,13 +252,13 @@ This section allows you select what type of workshop you want to run. The follow
    - Example of a participants list email + Example of a participants list email
    Example of a participants list email
    - Example of a participants list in CSV format + Example of a participants list in CSV format
    Example of a participants list in CSV format
    @@ -269,7 +269,7 @@ This section allows you select what type of workshop you want to run. The follow ## Review
    - Carefully review the summary of the workshop before creating it! + Carefully review the summary of the workshop before creating it!
    Carefully review the summary of the workshop before creating it!
    @@ -279,7 +279,7 @@ Provides a summary of the workshop you are about to create including workshop ty ## Total Cost to Splunk
    - my_page + my_page
    Total cost estimate
    diff --git a/content/workshops/event-quick-start/_index.md b/content/workshops/event-quick-start/_index.md index 10b76dd..b804982 100644 --- a/content/workshops/event-quick-start/_index.md +++ b/content/workshops/event-quick-start/_index.md @@ -1,7 +1,7 @@ -+++ -title = "Event Quick Start Guide" -weight = 40 -+++ +--- +title: "Event Quick Start Guide" +weight: 40 +--- This guide will help you create and manage workshop 'events' in Splunk Show. @@ -11,11 +11,11 @@ Events provide a streamlined way to run hands-on workshops with automated instan This quick start guide covers: -- [What is a Splunk Show 'Event'?](what-is-an-event/) - Understanding the different workshop types available -- [Choosing a Workshop Type](choosing-workshop-type/) - Decision guidance for selecting the right format -- [Quick Start: Creating an Event](creating-an-event/) - Step-by-step instructions for event setup -- [Inviting Attendees to an Event](inviting-attendees/) - How to get participants enrolled -- [Using Passcodes for Anonymous Enrolments](anonymous-passcodes/) - Alternative enrolment method without Splunk.com accounts +- [What is a Splunk Show 'Event'?](/workshops/event-quick-start/what-is-an-event/) - Understanding the different workshop types available +- [Choosing a Workshop Type](/workshops/event-quick-start/choosing-workshop-type/) - Decision guidance for selecting the right format +- [Quick Start: Creating an Event](/workshops/event-quick-start/creating-an-event/) - Step-by-step instructions for event setup +- [Inviting Attendees to an Event](/workshops/event-quick-start/inviting-attendees/) - How to get participants enrolled +- [Using Passcodes for Anonymous Enrolments](/workshops/event-quick-start/anonymous-passcodes/) - Alternative enrolment method without Splunk.com accounts ## Quick Links diff --git a/content/workshops/event-quick-start/anonymous-passcodes.md b/content/workshops/event-quick-start/anonymous-passcodes.md index de860f5..f7c0118 100644 --- a/content/workshops/event-quick-start/anonymous-passcodes.md +++ b/content/workshops/event-quick-start/anonymous-passcodes.md @@ -1,7 +1,7 @@ -+++ -title = "Using Passcodes for Anonymous Enrolments" -weight = 50 -+++ +--- +title: "Using Passcodes for Anonymous Enrolments" +weight: 50 +--- Enabling this option will provide you with unique passcode for you event, which you can then copy and share with any users who do not have a Splunk.com account and are not able to sign up for one. Passcodes are unique for each event and expire at the end of the event. Your event can also have a mixture of Splunk.com enrolled users and passcode enrolled users. @@ -12,7 +12,7 @@ Enabling this option will provide you with unique passcode for you event, which When a user is given a passcode they will visit the usual event link and this will take them to the usual sign in page.
    - The Splunk Show login page + The Splunk Show login page
    The Splunk Show login page
    @@ -23,7 +23,7 @@ When a user is given a passcode they will visit the usual event link and this wi From the sign in page, they will click on **Enter a passcode instead** and enter/paste the passcode.
    - The passcode option on the Splunk Show login page + The passcode option on the Splunk Show login page
    The passcode option on the Splunk Show login page
    @@ -34,7 +34,7 @@ From the sign in page, they will click on **Enter a passcode instead** and enter They will then be taken to the event page where they are automatically enrolled and will see their instance information once the event starts.
    - Participants using a passcode will automatically be enrolled and taken to the relevant event page + Participants using a passcode will automatically be enrolled and taken to the relevant event page
    Participants using a passcode will automatically be enrolled and taken to the relevant event page.
    diff --git a/content/workshops/event-quick-start/choosing-workshop-type.md b/content/workshops/event-quick-start/choosing-workshop-type.md index fdccadc..7e7d8fb 100644 --- a/content/workshops/event-quick-start/choosing-workshop-type.md +++ b/content/workshops/event-quick-start/choosing-workshop-type.md @@ -1,12 +1,12 @@ -+++ -title = "Choosing a Workshop Type" -weight = 20 -+++ +--- +title: "Choosing a Workshop Type" +weight: 20 +--- The following flowchart should help you choose the correct workshop type:
    - +
    Workshop type decision flowchart
    diff --git a/content/workshops/event-quick-start/creating-an-event.md b/content/workshops/event-quick-start/creating-an-event.md index 47d8626..6e4f4e7 100644 --- a/content/workshops/event-quick-start/creating-an-event.md +++ b/content/workshops/event-quick-start/creating-an-event.md @@ -1,7 +1,7 @@ -+++ -title = "Quick Start: Creating an Event" -weight = 30 -+++ +--- +title: "Quick Start: Creating an Event" +weight: 30 +--- {{% notice note %}} The steps on this page are simplified. Please see the [Creating a Workshop/Event](/workshops/creating-workshops/) for complete details of all possible available configuration options. @@ -11,17 +11,17 @@ The steps on this page are simplified. Please see the [Creating a Workshop/Event ### 1. Navigate to Create Workshop -Log in to [Splunk Show](https://show.splunk.com) and [find the workshop template you need](/finding-content). Click on **Launch instance** (if browsing via the Catalog page) or **New workshop** (if you're on the template page). +Log in to [Splunk Show](https://show.splunk.com) and [find the workshop template you need](/finding-content/). Click on **Launch instance** (if browsing via the Catalog page) or **New workshop** (if you're on the template page).
    - The New Workshop button on the template page + The New Workshop button on the template page
    The New Workshop button on the template page
    - The Launch Instance button on the Catalog page + The Launch Instance button on the Catalog page
    The Launch Instance button on the Catalog page
    @@ -42,7 +42,7 @@ For customer workshops always tie your request to a Salesforce account, opportun ##### Workshop Type -Choose either **Private event** or **Public event** depending on which one you need (see [this flowchart](../choosing-workshop-type/)). +Choose either **Private event** or **Public event** depending on which one you need (see [this flowchart](/workshops/event-quick-start/choosing-workshop-type/)). ##### Provisioning Start @@ -83,7 +83,7 @@ To avoid instances being terminated during the workshop, **ensure your attendees {{% /notice %}} {{% notice info %}} -If you intend on just sharing the instance details with your participants via a CSV list (i.e. not having them enrol in an event via Splunk Show) then we recommend you run your workshop as a '[Normal Workshop](/workshops/creating-workshops)' and not an event. +If you intend on just sharing the instance details with your participants via a CSV list (i.e. not having them enrol in an event via Splunk Show) then we recommend you run your workshop as a '[Normal Workshop](/workshops/creating-workshops/)' and not an event. {{% /notice %}} ##### Allow Anonymous Enrolment via Passcode @@ -94,4 +94,4 @@ If you intend on just sharing the instance details with your participants via a Review your settings and click **Create.** -You can now start [inviting your attendees](../inviting-attendees/)! +You can now start [inviting your attendees](/workshops/event-quick-start/inviting-attendees/)! diff --git a/content/workshops/event-quick-start/inviting-attendees.md b/content/workshops/event-quick-start/inviting-attendees.md index f3a8f62..ef231b3 100644 --- a/content/workshops/event-quick-start/inviting-attendees.md +++ b/content/workshops/event-quick-start/inviting-attendees.md @@ -1,14 +1,14 @@ -+++ -title = "Inviting Attendees to an Event" -weight = 40 -+++ +--- +title: "Inviting Attendees to an Event" +weight: 40 +--- ## Inviting to a Public Event -Ask users to go to `http://show.splunk.com` and log in. They will be asked to log in with their splunk.com account or enter a [passcode](../anonymous-passcodes/) instead. +Ask users to go to `http://show.splunk.com` and log in. They will be asked to log in with their splunk.com account or enter a [passcode](/workshops/event-quick-start/anonymous-passcodes/) instead.
    - The Splunk Show login page + The Splunk Show login page
    The Splunk Show login page
    @@ -25,7 +25,7 @@ When they click on the event they will be able to click **Enroll**. Open your workshop in Show by clicking on it under the _My instances_ section of the home page. Click on the **Invite people** link.
    - The Invite people option on the event page + The Invite people option on the event page
    ### Inviting via email @@ -34,13 +34,13 @@ Paste in a CSV list of the attendees' email addresses and click **SEND INVITES**
    - Add a csv list of event participants to send them an invite email + Add a csv list of event participants to send them an invite email
    Add a csv list of event participants to send them an invite email
    - Example of an event invite email + Example of an event invite email
    Example of an event invite email
    diff --git a/content/workshops/event-quick-start/what-is-an-event.md b/content/workshops/event-quick-start/what-is-an-event.md index 5402447..14c8e46 100644 --- a/content/workshops/event-quick-start/what-is-an-event.md +++ b/content/workshops/event-quick-start/what-is-an-event.md @@ -1,7 +1,7 @@ -+++ -title = "What is a Splunk Show 'Event'?" -weight = 10 -+++ +--- +title: "What is a Splunk Show 'Event'?" +weight: 10 +--- In Splunk Show you have three options for running a hands-on customer workshop: diff --git a/content/workshops/manage-events.md b/content/workshops/manage-events.md index 271d4cb..08d6ae0 100644 --- a/content/workshops/manage-events.md +++ b/content/workshops/manage-events.md @@ -1,14 +1,14 @@ -+++ -title = "Managing Workshop Events" -weight = 30 -+++ +--- +title: "Managing Workshop Events" +weight: 30 +--- To manage a workshop event, locate the event on the home page under **My instances** and click on the event.
    - my_page + my_page
    Event in My instances
    @@ -16,16 +16,16 @@ To manage a workshop event, locate the event on the home page under **My instanc In addition to the options available for a 'Normal workshop', events have the following additional options: -my_page +my_page * **Event Link** - this is the shareable link to your workshop event. Click this link to visit the event page. Alternatively, click on the copy icon to the right to copy the URL to your clipboard, ready to share with invitees. You can also edit this link via the **Invite people** popup window. - my_page + my_page * **User notes** - populates the 'Event notes' on the event page. Add any participant-facing notes or links related to this workshop event (URLs will automatically be detected and made clickable).
    - my_page + my_page
    Example of what workshop attendees will see when you add text to the User notes field
    @@ -38,7 +38,7 @@ In addition to the options available for a 'Normal workshop', events have the fo * **Event participants** - allows you to manage the participants for your event, including viewing a list of attendees who are either enrolled or invited, inviting additional participants, exporting a CSV list of all participants and accessing participants' instance details.
    - my_page + my_page
    Example of an event participant with both passcode and Splunk.com enrolled users, with a link to each user’s instances
    @@ -52,23 +52,23 @@ In addition to the options available for a 'Normal workshop', events have the fo * **Event Managers** - allows you to add additional Show users as an event manager. Any users who are added as an event manager will see the event listed under **My instances** on their homepage and will have full access to manage users and workshop instances.
    - my_page + my_page
    Click 'Add managers' to add a colleague to help manage your workshop
    - my_page + my_page
    Add other Show users as workshop managers
    -* **Manage event privacy** - allows you to switch between making the event a **Public event** or a **Private event** (see [Creating Workshops](../creating-workshops/#workshop-type) for more info!) You can also copy the direct link to the event (useful for sharing in a calendar invite) to your clipboard and enable/disable the option to allow anyone with the event link to access and enrol in the event. +* **Manage event privacy** - allows you to switch between making the event a **Public event** or a **Private event** (see [Creating Workshops](/workshops/creating-workshops/#workshop-type) for more info!) You can also copy the direct link to the event (useful for sharing in a calendar invite) to your clipboard and enable/disable the option to allow anyone with the event link to access and enrol in the event.
    - my_page + my_page
    Switch between a public or private event at any time!
    @@ -81,7 +81,7 @@ In addition to the options available for a 'Normal workshop', events have the fo * **Discard Old Links** - when this option is enabled, Splunk Show will automatically purge/delete the previous custom URL you used. If you disable this option, any custom URLs you have used for this stack will be retained (and will continue to work) until the stack is terminated, at which time the custom URL(s) will be deleted and can be used again by you or someone else.
    - my_page + my_page
    You can customise your event URL
    @@ -89,13 +89,13 @@ In addition to the options available for a 'Normal workshop', events have the fo
    - Grouped Resources 1 + Grouped Resources 1
    Example of inviting two people using their email addresses
    - Grouped Resources 2 + Grouped Resources 2
    Example invite email from Splunk Show
    @@ -107,13 +107,13 @@ In addition to the options available for a 'Normal workshop', events have the fo You can optionally enable the 'ON USER ENROLLMENT TO EVENT' Email or Slack (Splunkers only) notification(s) under your Show user settings.
    - my_page + my_page
    Receive an email or Slack notification when someone enrols in an event
    -Please see [Notifications](../../account-settings/notifications/) for instructions on how to manage notifications. +Please see [Notifications](/account-settings/notifications/) for instructions on how to manage notifications. {{% /notice %}} * **Add event manager** - launches the 'Add managers' popup where you can add the email address of another Show user. They will receive an email invitation - as well as a notification within Show - to join your workshop event as an additional manager. If they accept the invite they will have full access to the event management page as if they had spun up the event themselves. @@ -122,16 +122,16 @@ Please see [Notifications](../../account-settings/notifications/) for instructio You can customise your event thumbnail image by clicking on the upload button in the corner of the image. -my_page +my_page Click on **upload file…** and browse to the image you want to upload. -my_page +my_page Move the image to fit within the available area and click on **Upload** to add your image. If you need to reset the image back to the default, click on **Reset**.
    - my_page + my_page
    Click and drag to move your image. Scroll to zoom in and out
    @@ -140,7 +140,7 @@ Move the image to fit within the available area and click on **Upload** to add y The workshop event will now use your custom image!
    - my_page + my_page
    Event with custom thumbnail
    @@ -152,15 +152,15 @@ If your event is still **SCHEDULED** you can edit the provisioning time (the tim Edit the schedule by scrolling to the **Provisioning Time** section and clicking on the edit button. Click on **Submit** to save your changes. -my_page +my_page {{% notice info %}} **Event Already RUNNING?** -If your event is already showing as RUNNING you cannot change the provisioning or start times. You can, however, still edit the instance running schedule under the **Schedule** section or extend the life of your workshop instances by clicking *Change lifetime* (top right of the page) and choosing a new expiry date for your workshop (see [Managing Demos](../../demos/managing-demos/#extend-instances-change-lifetime) for more information). +If your event is already showing as RUNNING you cannot change the provisioning or start times. You can, however, still edit the instance running schedule under the **Schedule** section or extend the life of your workshop instances by clicking *Change lifetime* (top right of the page) and choosing a new expiry date for your workshop (see [Managing Demos](/demos/managing-demos/#extend-instances-change-lifetime) for more information). {{% /notice %}}
    - my_page + my_page
    Edit the instance running schedule to adjust the hours your instances will be available
    @@ -171,7 +171,7 @@ If your event is already showing as RUNNING you cannot change the provisioning o The **Additional Settings** section allows you to enable or disable passcode authentication and enrolment for your event. Click on the edit icon to enable or disable the option.
    - my_page + my_page
    You can enable or disable the passcode feature at any time
    @@ -179,7 +179,7 @@ The **Additional Settings** section allows you to enable or disable passcode aut Enabling this option will provide you with unique passcode for you event, which you can then copy and share with any users who do not have a Splunk.com account and are not able to sign up for one. Passcodes are unique for each event and expire at the end of the event. Your event can also have a mixture of Splunk.com enrolled users and passcode enrolled users. -my_page +my_page {{% notice info %}} ### Enrolling Using a Passcode @@ -187,13 +187,13 @@ Enabling this option will provide you with unique passcode for you event, which When a user is given a passcode they will visit the usual event link and this will take them to the usual sign in page. From here they will click on **Enter a passcode instead** and enter/paste the passcode.
    - my_page + my_page
    Attendees without an account should use the 'Enter a passcode instead' option
    -my_page +my_page They will then be taken to the event page where they are automatically enrolled and will see their instance information once the event starts. {{% /notice %}} @@ -204,16 +204,16 @@ The **Resources** section of the event page allows you to manage the instances t Click on **Manage instances** to see a list of instances. -my_page +my_page Click on **Go to instance** to access the instance. -my_page +my_page **Instance name** - click on an instance name to view instance specific information including the connection information, utilization metrics and who (if anyone) is assigned to it.
    - my_page + my_page
    Click on the Instance name to view detailed information about an individual instance
    @@ -227,7 +227,7 @@ When a user enrols in a workshop Show will assign them an instance (provided the Click on the **Instance participants** tab to see who is assigned to that instance. Note that for some workshops you will have more than one user per instance.
    - my_page + my_page
    Example of a participant assigned to an instance
    @@ -238,7 +238,7 @@ Click on the **Instance participants** tab to see who is assigned to that instan If a participant experiences an issue with their assigned instance you can assign them to another instance by selecting them from the **Instance participants** list and clicking on the **Assign another instance to user** button.
    - my_page + my_page
    You can move users to another instance when needed
    @@ -246,4 +246,4 @@ If a participant experiences an issue with their assigned instance you can assig On the **Move participants to another instance** popup, select an available instance and click on **MOVE** to reassign the participant(s) to that instance. -my_page +my_page diff --git a/content/workshops/managing-workshops.md b/content/workshops/managing-workshops.md index d41f02b..3727b32 100644 --- a/content/workshops/managing-workshops.md +++ b/content/workshops/managing-workshops.md @@ -1,7 +1,7 @@ -+++ -title = "Managing Normal Workshops" -weight = 20 -+++ +--- +title: "Managing Normal Workshops" +weight: 20 +--- @@ -9,10 +9,10 @@ weight = 20 To manage a 'Normal workshop' (i.e. not an event), locate the workshop on the home page under **My instances** and click on the workshop. -When managing a workshop the same base options apply as when managing demo instances (see [Managing Demos](../../demos/managing-demos/).) +When managing a workshop the same base options apply as when managing demo instances (see [Managing Demos](/demos/managing-demos/).)
    - my_page + my_page
    Normal workshop in My instances
    @@ -27,14 +27,14 @@ Since a workshop typically consists of multiple Splunk instances, you will need {{% /notice %}}
    - my_page + my_page
    Example of downloading a CSV list of instance for a Normal workshop
    - my_page + my_page
    Example CSV export of workshop instances
    @@ -42,7 +42,7 @@ Since a workshop typically consists of multiple Splunk instances, you will need {{% notice tip %}} **Is Your Workshop an 'Event'?** -If you're running a workshop event, attendees will be able to access their own instance information directly in Show - you do not need to share their connection details manually (see [Events](../events/).) +If you're running a workshop event, attendees will be able to access their own instance information directly in Show - you do not need to share their connection details manually (see [Events](/workshops/manage-events/).) {{% /notice %}} ### Resources @@ -54,7 +54,7 @@ To **view a list of workshop instances** - click on **Manage instances.** A list of instances will appear showing the status of each instance. Click on **Go to instance** to access the instance.
    - my_page + my_page
    Example list of instances in a ‘Normal workshop’
    @@ -65,7 +65,7 @@ Click on the name of an instance to view detailed information including: * **Connection information** - connection information such as login credentials for the instance
    - my_page + my_page
    Example of instance information displayed when you click on an instance in the ‘Manage Instances’ list
    @@ -74,7 +74,7 @@ Click on the name of an instance to view detailed information including: * **Instance utilization** - system metrics for the instance such as memory, CPU and disk usage.
    - my_page + my_page
    Example of utilization metrics for a workshop instance
    @@ -87,7 +87,7 @@ To Increase or decrease the number of required workshop instances edit the **Ins Edit the quantity and click the green tick button to save the changes.
    - my_page + my_page
    Instances quantity settings
    @@ -103,14 +103,14 @@ This feature is initially only available for the **Splunk4Rookies** workshop tem For templates that include a 'Splunk Show Workshop Monitor' instance, workshop/event managers will see an additional **Admin Resources** section on the workshop page, containing a single _Splunk Show Workshop Monitor_ instance. **Monitoring instances are only visible to managers and attendees do not see them.**
    - my_page + my_page
    Example of a Splunk Show Workshop Monitor instance
    - my_page + my_page
    Workshop monitor connection information
    @@ -123,7 +123,7 @@ All attendee instances will automatically forward their internal logs to the mon Login to the Splunk Show Workshop Monitor using the credentials provided and you will see the analytics dashboard.
    - my_page + my_page
    Workshop insights are provided via the Splunk Show Workshop Monitor instance
    @@ -131,4 +131,4 @@ Login to the Splunk Show Workshop Monitor using the credentials provided and you ## Managing an Event -See the [Events](../events/) section for detailed information on managing workshop events. +See the [Events](/workshops/manage-events/) section for detailed information on managing workshop events. diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..1123fbc --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/splunk/splunk-show-docs + +go 1.26.3 + +require github.com/splunk/hugo-theme-splunk-workshop v0.8.1 // indirect diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..c9b66d9 --- /dev/null +++ b/go.sum @@ -0,0 +1,2 @@ +github.com/splunk/hugo-theme-splunk-workshop v0.8.1 h1:0IkwsfkkQ/62u6Dl+5I++/PE/EtzdW4ogpZYnnJQibU= +github.com/splunk/hugo-theme-splunk-workshop v0.8.1/go.mod h1:W41sA3uf5oTWqIUA1aUY4M0C/JEaMa0gV3CqVDs0ReA= diff --git a/hugo.toml b/hugo.toml new file mode 100644 index 0000000..8c43627 --- /dev/null +++ b/hugo.toml @@ -0,0 +1,99 @@ +baseURL = "https://splunk.github.io/splunk-show-docs/" +title = "Splunk Show Documentation" +enableEmoji = true +enableRobotsTXT = true +enableGitInfo = true +defaultContentLanguage = "en" + +[languages] + [languages.en] + label = "English" + locale = "en" + weight = 1 + +[module] + [module.hugoVersion] + extended = true + min = "0.161.1" + [[module.imports]] + path = "github.com/splunk/hugo-theme-splunk-workshop" + +[markup] + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true + [markup.goldmark.parser] + [markup.goldmark.parser.attribute] + block = true + title = true + [markup.tableOfContents] + startLevel = 2 + endLevel = 4 + ordered = false + [markup.highlight] + noClasses = false + lineNos = false + codeFences = true + guessSyntax = true + tabWidth = 2 + +[outputs] + home = ["HTML", "RSS", "JSON"] + section = ["HTML", "RSS"] + page = ["HTML"] + +[params] + brandName = "splunk>" + brandTagline = "" + description = "A comprehensive user guide for using the Splunk Show platform." + copyright = "© {year} Splunk LLC All rights reserved." + logoLight = "images/splunkshowlogo.png" + logoDark = "images/splunkshowlogo.png" + logoHeight = "40" + + defaultMode = "auto" + showThemeToggle = true + + colorAccent = "#FF007F" + colorAccent2 = "#FF9000" + colorAccent3 = "#FFAB0F" + colorAccentDark = "#D4006B" + colorAccentText = "#BD0D5F" + colorAccentTextDark = "#FF7DBA" + + colorInk = "#0C1724" + colorInkMuted = "#585B61" + colorPaper = "#FFFFFF" + colorSurface = "#F4F6FA" + colorSurfaceAlt = "#E9EDF2" + colorBorder = "#E1E5EC" + colorBorderStrong = "#C7CDD8" + + colorInkDark = "#F4F1EA" + colorInkMutedDark = "#9CA3AF" + colorPaperDark = "#0C1724" + colorSurfaceDark = "#141E2F" + colorSurfaceAltDark = "#1B2740" + colorBorderDark = "#1F2C44" + colorBorderStrongDark = "#2A3A56" + + splunkDataSansPro = true + fontUrl = "https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;600&display=swap" + fontDisplay = "'Splunk Data Sans Pro', ui-sans-serif, system-ui, -apple-system, 'Segoe UI', Roboto, sans-serif" + fontBody = "'Splunk Data Sans Pro', ui-sans-serif, system-ui, -apple-system, 'Segoe UI', Roboto, sans-serif" + fontMono = "'JetBrains Mono', ui-monospace, 'SF Mono', Menlo, Monaco, Consolas, monospace" + + showSidebar = true + showToc = true + showProgress = true + showLightTrails = true + contentMaxWidth = "720px" + + editURL = "" + repoURL = "" + + [params.social] + github = "" + twitter = "" + linkedin = "" + youtube = "" diff --git a/i18n/en.yaml b/i18n/en.yaml new file mode 100644 index 0000000..e3f5119 --- /dev/null +++ b/i18n/en.yaml @@ -0,0 +1,8 @@ +- id: workshops + translation: "Contents" +- id: searchPlaceholder + translation: "Search documentation…" +- id: notFoundLead + translation: "The page you're looking for slipped through the index. Try the contents list." +- id: browseWorkshops + translation: "Browse contents" diff --git a/layouts/_partials/custom-header.html b/layouts/_partials/custom-header.html new file mode 100644 index 0000000..06c43f9 --- /dev/null +++ b/layouts/_partials/custom-header.html @@ -0,0 +1,68 @@ + diff --git a/layouts/_partials/sidebar.html b/layouts/_partials/sidebar.html new file mode 100644 index 0000000..3ae3449 --- /dev/null +++ b/layouts/_partials/sidebar.html @@ -0,0 +1,36 @@ +{{- $home := site.Home -}} +{{- $current := . -}} + diff --git a/layouts/_partials/workshop-root.html b/layouts/_partials/workshop-root.html new file mode 100644 index 0000000..b91bcc2 --- /dev/null +++ b/layouts/_partials/workshop-root.html @@ -0,0 +1,23 @@ +{{- /* + Override: Always return a workshop root for non-home pages so the sidebar + renders on every section, including leaf sections with no child pages. +*/ -}} +{{- $page := . -}} +{{- $root := false -}} + +{{- if and (not $page.IsHome) (ne $page.Kind "404") (ne $page.Kind "taxonomy") -}} + {{- $candidates := slice $page | append $page.Ancestors -}} + {{- $n := len $candidates -}} + {{- $found := false -}} + {{- range seq $n -}} + {{- if not $found -}} + {{- $cand := index $candidates (sub $n .) -}} + {{- if not $cand.IsHome -}} + {{- $root = $cand -}} + {{- $found = true -}} + {{- end -}} + {{- end -}} + {{- end -}} +{{- end -}} + +{{- return $root -}} diff --git a/layouts/partials/assetbusting.gotmpl b/layouts/partials/assetbusting.gotmpl deleted file mode 100644 index cb48b83..0000000 --- a/layouts/partials/assetbusting.gotmpl +++ /dev/null @@ -1,12 +0,0 @@ -{{- $assetsBuster := "" }} -{{- $assetBusting := not site.Params.disableAssetsBusting }} -{{- if $assetBusting }} - {{- /* Use commit SHA if available (set via HUGO_PARAMS_assetVersion in CI) */}} - {{- with site.Params.assetVersion }} - {{- $assetsBuster = printf "?v=%s" . }} - {{- else }} - {{- /* Fallback to timestamp */}} - {{- $assetsBuster = printf "?%d" now.Unix }} - {{- end }} -{{- end }} -{{- return $assetsBuster }} diff --git a/layouts/partials/content-header.html b/layouts/partials/content-header.html deleted file mode 100644 index 04e8c8f..0000000 --- a/layouts/partials/content-header.html +++ /dev/null @@ -1 +0,0 @@ -{{- partial "tags.html" . }} diff --git a/layouts/partials/content-lead.html b/layouts/partials/content-lead.html deleted file mode 100644 index 3bfa2b5..0000000 --- a/layouts/partials/content-lead.html +++ /dev/null @@ -1,43 +0,0 @@ -{{- $versions := partialCached "_relearn/siteVersions.gotmpl" site.Home }} -{{- $pageVersion := site.Params.version | default "" }} -{{- if and $versions (not $pageVersion) }} - {{- warnf "WARNING you have configured `versions` but did not mark this site with a `version`; see https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/7/#7-6-0" }} -{{- end }} -{{- $latestVersion := "" }} -{{- with (where $versions "isLatest" true | first 1) }} - {{- range . }} - {{- $latestVersion = . }} - {{- end }} -{{- end }} -{{- with (where $versions "identifier" $pageVersion | first 1) }} - {{- range . }} - {{- $pageVersion = . }} - {{- end }} -{{- end }} -{{- if and - (not (site.Params.disableVersioningWarning | default .Params.disableVersioningWarning)) - (eq (.Store.Get "relearnOutputFormat") "html") - $pageVersion - $latestVersion - (ne $pageVersion.identifier $latestVersion.identifier) -}} - {{- $path := partial "_relearn/pageLangPath.gotmpl" . }} - {{- $url := print $latestVersion.baseURL $path }} - {{- if not $latestVersion.isAbs }} - {{- $url = print (partial "_relearn/relBaseUri.gotmpl" .) $url }} - {{- end }} - {{- partial "versioning-warning.html" (dict "page" . "pageUrl" (partial "permalink.gotmpl" (dict "to" .)) "pageVersion" $pageVersion "latestUrl" $url "latestVersion" "$latestVersion") }} -{{- end }} -{{- if not .Params.disableReadingTime }} -
    - - {{- $readingTime := .ReadingTime }} - {{- if eq $readingTime 0 }} - Less than 1 minute - {{- else if eq $readingTime 1 }} - 1 minute - {{- else }} - {{ $readingTime }} minutes - {{- end }} -
    -{{- end }} diff --git a/layouts/partials/custom-head.html b/layouts/partials/custom-head.html deleted file mode 100644 index da0ec61..0000000 --- a/layouts/partials/custom-head.html +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/layouts/partials/custom-header.html b/layouts/partials/custom-header.html deleted file mode 100644 index 0a5d04f..0000000 --- a/layouts/partials/custom-header.html +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/layouts/partials/logo.html b/layouts/partials/logo.html deleted file mode 100644 index 6755b55..0000000 --- a/layouts/partials/logo.html +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/layouts/partials/menu-footer.html b/layouts/partials/menu-footer.html deleted file mode 100644 index f5b76cb..0000000 --- a/layouts/partials/menu-footer.html +++ /dev/null @@ -1,3 +0,0 @@ -

    - © 2005 - {{ now.Year }} Splunk LLC. All rights reserved. -

    diff --git a/static/css/custom.css b/static/css/custom.css deleted file mode 100644 index 0d489e2..0000000 --- a/static/css/custom.css +++ /dev/null @@ -1,84 +0,0 @@ -/* Orange text for conditional/contextual notes */ -.conditional-note { - color: #E16C01; -} - -/* Red text for restrictions/limitations */ -.restriction-note { - color: #DC143C; - font-style: italic; -} - -/* Red text only, no other formatting */ -.text-red { - color: #DC143C; -} - -/* Label/badge with pink background matching sidebar */ -.label { - display: inline-block; - padding: 2px 8px; - margin-left: 6px; - font-size: 0.85em; - font-weight: 600; - color: #ffffff; - background-color: rgba(206, 0, 112, 1); - border-radius: 4px; - vertical-align: middle; -} - -/* Dark theme adjustments - lighter pink for better contrast (WCAG AA compliant) */ -[data-r-theme-variant="splunk-dark"] { - --PRIMARY-color: #FF4D9A !important; - --ACCENT-color: #FF4D9A !important; - --LINK-color: #FF4D9A !important; - --LINK-HOVER-color: #FF6BAF !important; -} - -[data-r-theme-variant="splunk-dark"] .label { - background-color: #FF4D9A; -} - -[data-r-theme-variant="splunk-dark"] .reading-time-badge { - color: #FF4D9A !important; -} - -/* Apply pink to content area links only, not sidebar */ -[data-r-theme-variant="splunk-dark"] #R-body-inner a { - color: #FF4D9A !important; -} - -[data-r-theme-variant="splunk-dark"] #R-body-inner a:hover { - color: #FF6BAF !important; -} - -/* Keep sidebar links white/default in dark mode */ -[data-r-theme-variant="splunk-dark"] #R-sidebar a { - color: var(--MENU-SECTIONS-LINK-color) !important; -} - -[data-r-theme-variant="splunk-dark"] #R-sidebar a:hover { - color: var(--MENU-SECTIONS-LINK-HOVER-color) !important; -} - -/* Keep sidebar header (logo/search area) using original pink in dark mode */ -[data-r-theme-variant="splunk-dark"] #R-header, -[data-r-theme-variant="splunk-dark"] #R-header-wrapper { - background-color: rgba(206, 0, 112, 1) !important; -} - -[data-r-theme-variant="splunk-dark"] #R-header a { - color: #ffffff !important; -} - -/* Top navigation bar - use lighter pink in dark mode */ -[data-r-theme-variant="splunk-dark"] #R-topbar a, -[data-r-theme-variant="splunk-dark"] #R-topbar .breadcrumb-item, -[data-r-theme-variant="splunk-dark"] .topbar-breadcrumbs a { - color: #FF4D9A !important; -} - -[data-r-theme-variant="splunk-dark"] #R-topbar a:hover, -[data-r-theme-variant="splunk-dark"] .topbar-breadcrumbs a:hover { - color: #FF6BAF !important; -} diff --git a/themes/relearn b/themes/relearn deleted file mode 160000 index 8bb66fa..0000000 --- a/themes/relearn +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 8bb66fa674351f3a0b0917a7552caac686eca920 From 486adb3faf0438f6c1a7d29f3aa0d37da1807dd1 Mon Sep 17 00:00:00 2001 From: Rob Larkman Date: Tue, 26 May 2026 17:44:30 +0100 Subject: [PATCH 2/4] redesign --- hugo.toml | 4 +- layouts/_partials/custom-header.html | 42 ++++-- layouts/_partials/footer.html | 129 ++++++++++++++++++ static/images/splunkshowlogo-dark.png | Bin 0 -> 279463 bytes ...kshowlogo.png => splunkshowlogo-light.png} | Bin 5 files changed, 163 insertions(+), 12 deletions(-) create mode 100644 layouts/_partials/footer.html create mode 100644 static/images/splunkshowlogo-dark.png rename static/images/{splunkshowlogo.png => splunkshowlogo-light.png} (100%) diff --git a/hugo.toml b/hugo.toml index 8c43627..64ff44e 100644 --- a/hugo.toml +++ b/hugo.toml @@ -47,8 +47,8 @@ defaultContentLanguage = "en" brandTagline = "" description = "A comprehensive user guide for using the Splunk Show platform." copyright = "© {year} Splunk LLC All rights reserved." - logoLight = "images/splunkshowlogo.png" - logoDark = "images/splunkshowlogo.png" + logoLight = "images/splunkshowlogo-dark.png" + logoDark = "images/splunkshowlogo-light.png" logoHeight = "40" defaultMode = "auto" diff --git a/layouts/_partials/custom-header.html b/layouts/_partials/custom-header.html index 06c43f9..11859cc 100644 --- a/layouts/_partials/custom-header.html +++ b/layouts/_partials/custom-header.html @@ -54,15 +54,37 @@ .sidebar-more__note { color: rgba(230, 230, 230, 0.8); } - @media (prefers-color-scheme: light) { - .sidebar-more__note { - color: rgba(230, 230, 230, 0.8); - } - .sidebar-more__heading { - color: rgba(0, 0, 0, 1); - } - .sidebar-more__divider { - border-top-color: rgba(255, 255, 255, 0.1); - } + :root:not([data-theme="dark"]) .sidebar-more__heading { + color: rgba(0, 0, 0, 1); + } + :root:not([data-theme="dark"]) .sidebar-more__note { + color: rgba(80, 80, 80, 0.7); + } + [data-theme="dark"] .sidebar-more__heading { + color: rgba(255, 255, 255, 1); + } + [data-theme="dark"] .sidebar-more__note { + color: rgba(230, 230, 230, 0.8); + } + [data-theme="dark"] { + --color-paper-dark: #202020; + --color-border: #4a4a4a; + } + .breadcrumb { + margin-bottom: 0.75rem; + } + .eyebrow { + margin-bottom: 0.5rem; + } + .content > h1 { + margin-top: 0.5rem; + margin-bottom: 1.5rem; + } + .page { + padding-top: calc(var(--header-h) + 1rem); + } + .hero__title, + .hero__lead { + text-align: center; } diff --git a/layouts/_partials/footer.html b/layouts/_partials/footer.html new file mode 100644 index 0000000..e98d412 --- /dev/null +++ b/layouts/_partials/footer.html @@ -0,0 +1,129 @@ +{{- $p := .Site.Params -}} +{{- /* Two-tier dark footer in the Material-for-MkDocs style. + + Top tier ("meta") : brand wordmark + tagline + social icon row. + Bottom tier ("legal"): copyright + "Built with Hugo" attribution. + + The footer is always dark regardless of the active theme — gives every + page a consistent grounding zone. The brand bloom (light-trails) sits + behind it, mirrored to anchor on the left. */ -}} +