Skip to content

Commit

Permalink
Update docs to Butler v9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@mountaindude
mountaindude committed Jun 13, 2023
1 parent 277368f commit 6ae1377
Show file tree
Hide file tree
Showing 64 changed files with 2,161 additions and 478 deletions.
260 changes: 112 additions & 148 deletions config.toml
View file
@@ -1,31 +1,39 @@
baseURL = "/"
languageCode = "en-us"
title = "Butler"
theme = [ "docsy", "hugo-notice", "hugo-dynamic-tabs"]
theme = [ "github.com/google/docsy", "github.com/google/docsy/dependencies", "hugo-notice", "hugo-dynamic-tabs"]

description = "Butler adds features and services to Qlik Sense Enterprise on Windows, making it easier to develop for and operate QSEoW."
Paginate = 20

# Added to support publishing to GitHub Pages, as per https://gohugo.io/hosting-and-deployment/hosting-on-github/
publishDir = "docs"

# SEO
enableRobotsTXT = true

# Docsy: Gives values to .Lastmod etc.
enableGitInfo = true

# Docsy: Language settings
# Language settings
contentDir = "content/en"
defaultContentLanguage = "en"
# Tell Hugo not to include the /en/ element in the URL path for English docs:
defaultContentLanguageInSubdir = false
# Docsy: Useful when translating.
# Useful when translating.
enableMissingTranslationPlaceholders = true

enableRobotsTXT = true

# Will give values to .Lastmod etc.
enableGitInfo = true

# Comment out to enable taxonomies in Docsy
disableKinds = ["taxonomy", "taxonomyTerm"]

# Docsy: Highlighting config
# You can add your own taxonomies
[taxonomies]
tag = "tags"
category = "categories"

[params.taxonomy]
# set taxonomyCloud = [] to hide taxonomy clouds
taxonomyCloud = ["tags", "categories"]

# If used, must have same length as taxonomyCloud
taxonomyCloudTitle = ["Tag Cloud", "Categories"]

# set taxonomyPageHeader = [] to hide taxonomies on the page headers
taxonomyPageHeader = ["tags", "categories"]


# Highlighting config
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
Expand All @@ -34,162 +42,128 @@ pygmentsUseClassic = false
# See https://help.farbox.com/pygments.html
pygmentsStyle = "tango"

# Docsy: First one is picked as the Twitter card image if not set on page.
#images = ["images/project-illustration.png"]

# Top-level navigation (horizontal)
[[menu.main]]
name = "What is Butler?"
weight = -103
url = "/docs/about/butler/"
[[menu.main]]
name = "Documentation"
weight = -101
url = "/docs/"
# [[menu.main]]
# name = "Community"
# weight = -100
# url = "https://ptarmiganlabs.com"
[[menu.main]]
name = "News"
weight = -100
url = "/blog"
[[menu.main]]
name = "Blog"
weight = -99
url = "https://ptarmiganlabs.com"
[[menu.main]]
name = "The Butler family"
weight = -98
url = "/docs/about/butler-family"
[[menu.main]]
name = "About"
weight = -97
url = "/docs/about"
# [[menu.main]]
# name = "GitHub"
# weight = -97
# url = "https://github.com/ptarmiganlabs/butler"

# Docsy: Configure the format of URLs per section.
#[permalinks]
#blog = "/:section/:year/:month/:day/:slug/"

# Docsy: Configuration for Goldmark markdown parser, which is default from
# Hugo 0.60 onwards. https://github.com/yuin/goldmark/
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
# Allow Goldmark to render raw HTML:
unsafe = true
# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"

# Docsy: Image processing configuration.
# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
id = "UA-58487795-5"
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
id = "UA-00000000-0"

# Docsy: Language configuration
# Language configuration

[languages]
[languages.en]
title = "Butler"
description = "Butler adds features and services to Qlik Sense Enterprise on Windows, making it easier to develop for and operate QSEoW."
languageName ="English"
# Weight used for sorting in the language menu:
# Weight used for sorting.
weight = 1

# Below is an example of another language (Norwegian):
#[languages.no]
#title = "Docsy"
#description = "Docsy er operativsystem for skyen"
#languageName ="Norsk"
#contentDir = "content/no"
time_format_default = "2006-01-02"
time_format_blog = "2006-01-02"

# Site params
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

[params]
# Everything below this are Site Params

# GitHub repository for in-page links to editing a page and opening and issues.
github_repo = "https://github.com/ptarmiganlabs/butler-docs"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/ptarmiganlabs/butler"

RSSLink = "/index.xml"
author = "Ptarmigan Labs" # add your company name
github = "ptarmiganlabs" # add your github profile name
twitter = "ptarmiganlabs" # add your twitter profile
email = "info@ptarmiganlabs.com"
# Comment out if you don't want the "print entire section" link enabled.
[outputs]
section = ["HTML", "print", "RSS"]

[params]
copyright = "Ptarmigan Labs AB"
# privacy_policy = "https://policies.google.com/privacy"

# Docsy: Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "011737558837375720776:fsdu1nryfng"
# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]

# Text label for the version menu in the top bar of the website.
# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Releases"

# The major.minor version tag for the version of the docs represented in this
# branch of the repository. Used in the "version-banner" partial to display a
# version number for this doc set.
version = "v4.2"

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version = "0.0"

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://butler.ptarmiganlabs.com"

# A variable used in various docs to determine URLs for config files etc.
# To find occurrences, search the repo for 'params "githubbranch"'.
githubbranch = "v4.2"
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/google/docsy-example"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/ptarmiganlabs/butler"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""

# Add new release versions here. These entries appear in the drop-down menu
# at the top of the website.
# [[params.versions]]
# version = "v4.1"
# githubbranch = "master"
# url = "https://butler.ptarmiganlabs.com"
# Uncomment this if your GitHub repo does not have "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
github_branch= "master"

# [[params.versions]]
# version = "v4.0"
# githubbranch = "v4.0"
# url = "https://butler.ptarmiganlabs.com"
# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "d72aa9b2712488cc3"

# Enable Algolia DocSearch
algolia_docsearch = false

# [[params.versions]]
# version = "v1.0"
# githubbranch = "v1.0-branch"
# url = "https://v1-0-branch.kubeflow.org"
# Enable Lunr.js offline search
offlineSearch = false

# Docsy: User interface configuration
# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = false

# User interface configuration
[params.ui]
# Docsy: Enable to show the side bar menu in its compact state.
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to disable the About link in the site footer
footer_about_disable = false
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
navbar_logo = false
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
navbar_translucent_over_cover_disable = false
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = true
# Docsy: Disable the search box in the side bar.
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = true
# Docsy: Set to true to disable breadcrumb navigation.
breadcrumb_disable = false

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
[params.ui.feedback]
enable = true
enable = false
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Glad to hear it! Please <a href="https://github.com/ptarmiganlabs/butler/issues/new/choose">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/ptarmiganlabs/butler/issues/new/choose">tell us how we can improve</a>.'
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
Expand All @@ -204,17 +178,16 @@ no = 'Sorry to hear that. Please <a href="https://github.com/ptarmiganlabs/butle
icon = "fa fa-comments"
desc = "Talk about both developing and using Butler Auth."
[[params.links.user]]
name = "Ptarmigan Labs on Twitter"
url = "https://twitter.com/ptarmiganlabs"
icon = "fab fa-twitter"
desc = "Follow us here for latest news"
name = "Ptarmigan Labs"
url = "https://ptarmiganlabs.com"
icon = "fa fa-external-link"
desc = "Ptarmigan Labs website"
[[params.links.user]]
name = "LinkedIn"
url = "https://www.linkedin.com/in/gorsan/"
icon = "fab fa-linkedin"
desc = "Reach out to Ptarmigan Labs via LinkedIn"


# Docsy: "Developer" links will show on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
Expand All @@ -235,26 +208,17 @@ no = 'Sorry to hear that. Please <a href="https://github.com/ptarmiganlabs/butle



# hugo module configuration

[privacy]
[privacy.disqus]
disable = true
[privacy.googleAnalytics]
anonymizeIP = true
[module]
# uncomment line below for temporary local development of module
# replacements = "github.com/google/docsy -> ../../docsy"
[module.hugoVersion]
extended = true
min = "0.75.0"
[[module.imports]]
path = "github.com/google/docsy"
disable = false
# respectDoNotTrack = false
# useSessionStorage = false
[privacy.instagram]
disable = true
# simple = false
[privacy.twitter]
disable = true
# enableDNT = false
# simple = false
[privacy.vimeo]
disable = true
# simple = false
[privacy.youtube]
disable = true
# privacyEnhanced = false

[[module.imports]]
path = "github.com/google/docsy/dependencies"
disable = false

0 comments on commit 6ae1377

Please sign in to comment.