From 0dfe09437243f0afc3dfbb31a426b95af57ac81a Mon Sep 17 00:00:00 2001 From: gavinfish Date: Wed, 22 Jan 2020 13:50:16 +0800 Subject: [PATCH] Cleanup user journeys related configs and scripts --- data/setup.yml | 21 -- data/user-personas/users/app-developer.yaml | 40 --- .../user-personas/users/cluster-operator.yaml | 26 -- layouts/docs/docsportal.html | 12 - layouts/partials/docs/user-journey.html | 22 -- .../templates/user-journey-content.html | 23 -- static/js/user-journeys/home.js | 339 ------------------ static/js/user-journeys/toc.js | 30 -- 8 files changed, 513 deletions(-) delete mode 100644 data/user-personas/users/app-developer.yaml delete mode 100644 layouts/docs/docsportal.html delete mode 100644 layouts/partials/docs/user-journey.html delete mode 100644 layouts/partials/templates/user-journey-content.html delete mode 100644 static/js/user-journeys/home.js delete mode 100644 static/js/user-journeys/toc.js diff --git a/data/setup.yml b/data/setup.yml index 5e190350eb52c..b51c4d89a3df7 100644 --- a/data/setup.yml +++ b/data/setup.yml @@ -102,27 +102,6 @@ toc: - docs/admin/node-conformance.md -- title: User Journeys - landing_page: /docs/home/ - section: - - - title: Application Developer - section: - - docs/user-journeys/users/application-developer/foundational.md - - docs/user-journeys/users/application-developer/intermediate.md - - docs/user-journeys/users/application-developer/advanced.md - - title: Cluster Operator - section: - - docs/user-journeys/users/cluster-operator/foundational.md - - docs/user-journeys/users/cluster-operator/intermediate.md - - - title: Docs Contributor - path: /docs/home/?path=contributors&persona=docs-contributor&level=foundational - - title: Code Contributor - path: /docs/home/?path=contributors&persona=code-contributor&level=foundational - - title: Community Contributor - path: /docs/home/?path=contributors&persona=community-contributor&level=foundational - - title: Installing Addons path: /docs/concepts/cluster-administration/addons/ diff --git a/data/user-personas/users/app-developer.yaml b/data/user-personas/users/app-developer.yaml deleted file mode 100644 index 21a1d1afbabfb..0000000000000 --- a/data/user-personas/users/app-developer.yaml +++ /dev/null @@ -1,40 +0,0 @@ -id: app-developer -name: Application Developer -glossary_id: application-developer -index: 0 -foundational: - - label: Get started with a cluster - icon: fa-television - url: /docs/user-journeys/users/application-developer/foundational - - label: Deploy an application - icon: fa-retweet - url: /docs/user-journeys/users/application-developer/foundational#section-2 - - label: Understand basic Kubernetes architecture - icon: fa-cog - url: /docs/user-journeys/users/application-developer/foundational#section-3 - - label: Explore additional resources - icon: fa-book - url: /docs/user-journeys/users/application-developer/foundational#section-4 -intermediate: - - label: Learn additional workload patterns - icon: fa-cogs - url: /docs/user-journeys/users/application-developer/intermediate - - label: Deploy a production-ready workload - icon: fa-retweet - url: /docs/user-journeys/users/application-developer/intermediate#section-2 - - label: Improve your dev workflow with tooling - icon: fa-scissors - url: /docs/user-journeys/users/application-developer/intermediate#section-3 - - label: Explore additional resources - icon: fa-book - url: /docs/user-journeys/users/application-developer/intermediate#section-4 -advanced: - - label: Deploy an application with advanced features - icon: fa-sliders - url: /docs/user-journeys/users/application-developer/advanced - - label: Extend the Kubernetes API - icon: fa-arrows - url: /docs/user-journeys/users/application-developer/advanced#section-2 - - label: Explore additional resources - icon: fa-book - url: /docs/user-journeys/users/application-developer/advanced#section-3 diff --git a/data/user-personas/users/cluster-operator.yaml b/data/user-personas/users/cluster-operator.yaml index e17fc3865e89b..3d22a9895fec0 100644 --- a/data/user-personas/users/cluster-operator.yaml +++ b/data/user-personas/users/cluster-operator.yaml @@ -2,32 +2,6 @@ id: cluster-operator name: Cluster Operator glossary_id: cluster-operator index: 1 -foundational: - - label: Get an overview of Kubernetes - icon: fa-globe - url: /docs/user-journeys/users/cluster-operator/foundational - - label: Learn about Kubernetes basics - icon: fa-cog - url: /docs/user-journeys/users/cluster-operator/foundational#section-2 - - label: Get information about my cluster - icon: fa-info-circle - url: /docs/user-journeys/users/cluster-operator/foundational#section-3 - - label: Explore additional resources - icon: fa-compass - url: /docs/user-journeys/users/cluster-operator/foundational#section-4 -intermediate: - - label: "Work with Ingress, Networking, Storage, Workloads" - icon: fa-sliders - url: /docs/user-journeys/users/cluster-operator/intermediate - - label: "Implement security best practices" - icon: fa-shield - url: /docs/user-journeys/users/cluster-operator/intermediate#section-2 - - label: "Implement custom logging and monitoring" - icon: fa-heartbeat - url: /docs/user-journeys/users/cluster-operator/intermediate#section-3 - - label: "Additional Resources" - icon: fa-book - url: /docs/user-journeys/users/cluster-operator/intermediate#section-4 advanced: - label: "Connect to managed services using Service Catalog" icon: fa-puzzle-piece diff --git a/layouts/docs/docsportal.html b/layouts/docs/docsportal.html deleted file mode 100644 index 807529fc280b8..0000000000000 --- a/layouts/docs/docsportal.html +++ /dev/null @@ -1,12 +0,0 @@ -{{ define "content" }} - {{ if not .Params.notitle }} -

{{ .Title }}

- {{ end }} - {{ .Content }} - {{ if .Params.track }} - {{ partial "docs/user-journey.html" . }} - {{ end }} -{{ end }} - -{{ define "content-id" }}content{{ end }} - diff --git a/layouts/partials/docs/user-journey.html b/layouts/partials/docs/user-journey.html deleted file mode 100644 index 6fde88cf2e156..0000000000000 --- a/layouts/partials/docs/user-journey.html +++ /dev/null @@ -1,22 +0,0 @@ -
{{ .Params.track }}
-
- Introduction -
-
sections in this doc
-
- -
- -
- -{{ partial "insert-capture" (dict "ctx" . "id" "overview" )}} - -{{- with .Scratch.Get "__cid_body" -}} -{{ $body := replace . `` `
` | safeHTML }} -{{- $body -}} -{{- end -}} - -
- - diff --git a/layouts/partials/templates/user-journey-content.html b/layouts/partials/templates/user-journey-content.html deleted file mode 100644 index ffae17e6b9882..0000000000000 --- a/layouts/partials/templates/user-journey-content.html +++ /dev/null @@ -1,23 +0,0 @@ -
{{ .Params.track }}
-
- Introduction -
-
sections in this doc
-
- -
- -
- -{{ partial "templates/block" (dict "page" . "block" "overview" "purpose" "provides an introduction of this level.") }} - -{{- $capture := printf "__cid_%s" "body" -}} -{{- $body := .Scratch.Get $capture -}} -{{ with $body }} -{{ $b := replace $body "" "
- - diff --git a/static/js/user-journeys/home.js b/static/js/user-journeys/home.js deleted file mode 100644 index 9027783c40914..0000000000000 --- a/static/js/user-journeys/home.js +++ /dev/null @@ -1,339 +0,0 @@ -$( document ).ready(function() { - // UI defaults, used if page is loaded without other params - var defaults = { - path: 'users', - persona: 'app-developer', - level: 'foundational' - }; - // Top-level path types - var pathTypes = [ - 'users', - 'contributors', - 'migrators', - 'browse', - 'about' - ]; - // Paths that do not adhere to the actual user journey UI - var specialJourneyPaths = [ - 'browse', - 'about', - ]; - // Load persona JSON data structure - var info = JSON.parse($('#user-persona-data').html()); - - var containerDivs = [ - '.applicationDeveloperContainer', - '.infobarWrapper', - '#cardWrapper', - '#browsedocsWrapper', - '#aboutWrapper' - ]; - - // Stateful wrapper for a regular hash. Stores parameters AND keeps them in - // sync with the URL state. - var urlParamHash = function() { - var paramHash = {}; - - // Initialize internal params based on URL state - function init() { - var sPageURL = decodeURIComponent(window.location.search.substring(1)), - sURLVariables = sPageURL.split('&'), - sParameterName, - i; - - paramHash = {}; - for (i = 0; i < sURLVariables.length; i++) { - sParameterName = sURLVariables[i].split('='); - if (sParameterName[0] != "" && sParameterName[1] != "") - paramHash[sParameterName[0]] = sParameterName[1]; - } - return paramHash; // for visibility - } - - // Update both internal params and URL state - function set(key, value) { - if (value == null) { - delete paramHash[key]; - } else { - paramHash[key] = value; - } - - var urlWithoutQuery = window.location.href.split('?')[0]; - var urlHash = window.location.hash; - window.history.pushState(null,null, urlWithoutQuery + "?" + $.param(paramHash) + window.location.hash); - return paramHash; // for visibility - } - - // Get value from hash based on key - function get(key) { - return paramHash[key]; - } - - // Return number of elements in hash - function numElts() { - return Object.keys(paramHash).length; - } - - return { - init: init, - set: set, - get: get, - numElts: numElts, - }; - }(); - - // Create persona buttons in "I am..." section, e.g. Application Developer - function buildCards() { - for (var c in info) { - var card = document.createElement('div'); - card.className += "card_" + c; - - for (var i in info[c]) { - var button = document.createElement('div'); - button.className += 'buttons'; - button.setAttribute('data-button', i); - button.innerText = info[c][i]["name"]; - card.appendChild(button); - } - $('.cards').append(card); - } - } - - // Generate HTML for info links - function getInfoLinkHtml( - i = 1 //enumeration index for link id - , linkLabel = "Missing link label." //info link text - , linkUrl = "/docs/home/" //link to content - , linkIcon = "fa-ellipsis-h" //icon preceding info link text - ) { - var html = ''; - - /* - html template: -
-
- -
-
Missing link label.
-
- - defaults: - label: "Missing link label." - icon: "fa-ellipsis-h" - url: "docs.html" - */ - - html = '
' + - '
' + - '' + - '
' + - '
'+linkLabel+'
' + - '
'; - - return html; - } - - // Set links in the "I want to..." section, e.g. Setup a development environment - function setInfoData() { - var path = urlParamHash.get("path"); - var persona = urlParamHash.get("persona"); - var level = urlParamHash.get("level"); - - // info links specific to type/button/level - var contentArray = (typeof info[path][persona] !== 'undefined') - ? info[path][persona][level] - : [{ - label: 'Please select a role or persona in the "I AM..." section above.', - url: '#cardWrapper', - icon: 'fa-exclamation' - }]; - - //clear contents of #infobarLinks div - $('#infobarLinks').empty(); - //process and add each info link - for(i = 1; i <= contentArray.length; i++) { - var content = contentArray[i-1]; - - //append link to the end of the div - $('#infobarLinks').append(getInfoLinkHtml(i,content.label,content.url,content.icon)); - } - $('.infobarWrapper').css('visibility', 'visible'); - } - - // Hide persona wizard section if Browse Docs button is clicked - function toggleSections(path){ - for (i in containerDivs) { - if (!isSpecialJourney(path)) { - $(containerDivs[i]).show(); - } else { - $(containerDivs[i]).hide(); - } - } - - if (!isSpecialJourney(path)) { - $('.card_' + path).show(); - // TBD: Add code to set button to default to first in path list? - } else if (path == "browse") { - $('#browsedocsWrapper').show(); - } else if (path == "about") { - $('#aboutWrapper').show(); - } - } - - function isSpecialJourney(path) { - return (specialJourneyPaths.indexOf(path) != -1); - } - - // Click handler for high-level user journey paths ("Users", "Contributors", etc) - function handlePathClick(targetElt, fromPageload) { - // (1) Update stored state if necessary - var type = urlParamHash.get("path"); - if (!fromPageload) { - for (var i in pathTypes) { - var pathType = pathTypes[i]; - if (RegExp(pathType).test(targetElt.className)) { - type = pathType; - } - } - urlParamHash.set("path", type); - urlParamHash.set("persona", null); - urlParamHash.set("level", null); - - // record Google Analytics event - try { - ga('send', 'event', 'user-journeys', 'click', 'path', type); - } catch (ignored) { - - } - - } - - // (2) HTML behavior - $('.navButton').removeClass("keepShow"); - $(targetElt).addClass("keepShow"); - $('.cards > div').hide(); - // Hide or show user journeys if "Browse Docs is selected" - toggleSections(type); - } - - // Click handler + scroll for persona buttons in "I am..." section - // NOTE: ALL persona clicks also set a level. - function handlePersonaClick(targetElt, fromPageload, noScroll) { - // (1) Update stored state if necessary - if (!fromPageload) { - var persona = targetElt.getAttribute('data-button'); - urlParamHash.set('persona', persona); - - // record Google Analytics event - try { - ga('send', 'event', 'user-journeys', 'click', 'persona', persona); - } catch (ignored) { - - } - - } - // Use default level if not specified, in order to display the proper - // path-persona-level content - if (urlParamHash.get('level') == null) { - urlParamHash.set('level', defaults.level); - } - - // (2) HTML behavior - $('.buttons').removeClass('selected'); - $(targetElt).addClass('selected'); - // Update header to display new persona and level - var cardText = targetElt.innerText; - $('#subTitle').text(cardText); - handleLevelClick($('.level[data-name="' + urlParamHash.get('level') + '"]')[0], fromPageload); - // Scroll to user journey content - if (!noScroll) { - $('html,body').animate({ scrollTop: $("#subTitle").offset().top },'slow'); - } - } - - function handleLevelClick(targetElt, fromPageload) { - // (1) Update stored state if necessary - var level = targetElt.getAttribute('data-name'); - if (!fromPageload) { - urlParamHash.set('level', level); - - // record Google Analytics event - try { - ga('send', 'event', 'user-journeys', 'click', 'level', level); - } catch (ignored) { - - } - - } - - // (2) HTML behavior - $('.level').removeClass('selected'); - $(targetElt).addClass('selected'); - // Data loading to display the right content - setInfoData(); - } - - function showPersonaDefinition(targetElt) { - var persona = targetElt.getAttribute('data-button'); - - console.log($('.persona-def-data[data-name="' + persona + '"]')[0].innerHTML); - $("#persona-definition").html($('.persona-def-data[data-name="' + persona + '"]')[0].innerHTML); - $("#persona-definition").css("visibility", "visible"); - } - - function attachCardEvents() { - // Set up click handling for all paths ("Users", "Contributors", etc) - $('.paths .navButton').on('click', function(e) { - handlePathClick(e.currentTarget); - }); - // Set up click handling for personas ("Application Developer", etc) - $('.cards .buttons').on('click', function(e) { - handlePersonaClick(e.currentTarget); - }); - // Show persona definitions when hovering over card - $('.cards .buttons').hover( function(e) { - showPersonaDefinition(e.currentTarget); - }, function(e) { - $("#persona-definition").css("visibility", "hidden"); - $("#persona-definition").html("."); - }); - // Set up click handling for levels ("Foundational", "Intermediate", etc) - $('.level').on('click', function(e) { - handleLevelClick(e.currentTarget); - }); - } - - // Set up state based on URL query parameters or defaults - function setupCardState() { - // Initialize stored state - urlParamHash.init(); - var noScroll = urlParamHash.numElts() == 0; - for (key in defaults) { - if (!isSpecialJourney(urlParamHash.get('path')) && urlParamHash.get(key) == undefined) { - urlParamHash.set(key, defaults[key]); - } - } - // Update UI - handlePathClick($('.paths .' + urlParamHash.get('path'))[0], true); - if (!isSpecialJourney(urlParamHash.get('path'))) { - setTimeout(function() { - var elt = $('div[data-button="' + urlParamHash.get('persona') + '"]')[0]; - handlePersonaClick(elt, true, noScroll); - }, 200); - } - } - - window.onpopstate = function() { - window.history.back(); - } - - function main() { - // Set up UI - buildCards(); - attachCardEvents(); - setupCardState(); - } - - // What actually executes on page load - main(); -}); diff --git a/static/js/user-journeys/toc.js b/static/js/user-journeys/toc.js deleted file mode 100644 index dc527bc55044f..0000000000000 --- a/static/js/user-journeys/toc.js +++ /dev/null @@ -1,30 +0,0 @@ -$( document ).ready(function() { - function scrollToHash(hash) { - if (hash.length > 0) { - $('html, body').animate({ - scrollTop: $(`#${hash}`).offset().top - }, 500); - } - } - - $('#content h2').each(function(index) { - var title = $(this).text(); - var id = $(this).attr("id"); - - // inject headers into user journeys table-of-contents (buttons) - $("#user-journeys-toc").append(`
${index + 1}. ${title}
`) - - // replace content headers with styled banners - $(this).replaceWith(`


${index + 1}  ${title}
`) - }); - - $('div#user-journeys-toc a').each(function() { - $(this).click(function() { - var target = $(this).attr("href").replace("#", ""); - scrollToHash(target); - }); - }); - - // jump to section in URL now that anchors are created - scrollToHash(window.location.hash.substr(1)); -});