diff --git a/.gitignore b/.gitignore index 3307a3850..68269f356 100644 --- a/.gitignore +++ b/.gitignore @@ -23,6 +23,7 @@ .bin # Hugo site +publishedSite/ site/public/ site/resources/ site/.hugo_build.lock diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 000000000..16c70c299 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,10 @@ +[build] + base = "site/" + command = "hugo" + publish = "../publishedSite" + +[context.production.environment] + HUGO_VERSION = "0.92.2" + +[context.deploy-preview.environment] + HUGO_VERSION = "0.92.2" diff --git a/site/config.toml b/site/config.toml index faf1ebc25..3c4c3d343 100644 --- a/site/config.toml +++ b/site/config.toml @@ -1,10 +1,13 @@ -baseURL = "/" +baseURL = "https://kustomize.io" title = "Kustomize" +publishDir = "../publishedSite" + # Language settings contentDir = "content/en" defaultContentLanguage = "en" defaultContentLanguageInSubdir = false + # Useful when translating. enableMissingTranslationPlaceholders = true @@ -19,22 +22,6 @@ enableGitInfo = true # Comment out to enable taxonomies in Docsy # disableKinds = ["taxonomy", "taxonomyTerm"] -# 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 lang as taxonomyCloud -taxonomyCloudTitle = ["Tag Cloud", "Categories"] - -# set taxonomyPageHeader = [] to hide taxonomies on the page headers -taxonomyPageHeader = ["tags", "categories"] - - # Highlighting config pygmentsCodeFences = true pygmentsUseClasses = false @@ -71,25 +58,26 @@ id = "UA-00000000-0" [languages] [languages.en] title = "Kustomize" -description = "A Docsy example site" +description = "Documentation for Kustomize" languageName ="English" # Weight used for sorting. weight = 1 -[languages.no] -title = "Kustomize" -description = "Docsy er operativsystem for skyen" -languageName ="Norsk" -contentDir = "content/no" -time_format_default = "02.01.2006" -time_format_blog = "02.01.2006" -[languages.fa] -title = "اسناد گلدی" -description = "یک نمونه برای پوسته داکسی" -languageName ="فارسی" -contentDir = "content/fa" -time_format_default = "2006.01.02" -time_format_blog = "2006.01.02" +# [languages.no] +# title = "Kustomize" +# description = "Docsy er operativsystem for skyen" +# languageName ="Norsk" +# contentDir = "content/no" +# time_format_default = "02.01.2006" +# time_format_blog = "02.01.2006" + +# [languages.fa] +# title = "اسناد گلدی" +# description = "یک نمونه برای پوسته داکسی" +# languageName ="فارسی" +# contentDir = "content/fa" +# time_format_default = "2006.01.02" +# time_format_blog = "2006.01.02" [markup] [markup.goldmark] @@ -103,13 +91,8 @@ time_format_blog = "2006.01.02" # Everything below this are Site Params -# Comment out if you don't want the "print entire section" link enabled. -[outputs] -section = ["HTML", "print", "RSS"] - [params] -copyright = "The Docsy Authors" -privacy_policy = "https://policies.google.com/privacy" +copyright = "SIG CLI | Documentation Distributed under CC BY 4.0 | " # First one is picked as the Twitter card image if not set on page. # images = ["images/project-illustration.png"] @@ -118,40 +101,41 @@ privacy_policy = "https://policies.google.com/privacy" # This menu appears only if you have at least one [params.versions] set. version_menu = "Releases" -# Flag used in the "version-banner" partial to decide whether to display a +# 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 +# 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://example.com" +url_latest_version = "https://kustomize.io" # Repository configuration (URLs for in-page links to opening issues and suggesting changes) -github_repo = "https://github.com/google/docsy-example" +github_repo = "https://github.com/kubernetes-sigs/kustomize" # An optional link to a related project repo. For example, the sibling repository where your product code lives. -github_project_repo = "https://github.com/google/docsy" +github_project_repo = "https://github.com/kubernetes-sigs/kustomize" # Specify a value here if your content directory is not in your repo's root directory -# github_subdir = "" +github_subdir = "site" # Uncomment this if you have a newer GitHub repo with "main" as the default branch, # or specify a new value if you want to reference another branch in your GitHub links # github_branch= "main" # Google Custom Search Engine ID. Remove or comment out to disable search. -gcs_engine_id = "d72aa9b2712488cc3" +# gcs_engine_id = "d72aa9b2712488cc3" # Enable Algolia DocSearch algolia_docsearch = false # Enable Lunr.js offline search -offlineSearch = false +offlineSearch = true +offlineSearchMaxResults = 50 # Enable syntax highlighting and copy buttons on code blocks with Prism prism_syntax_highlighting = false @@ -163,7 +147,7 @@ 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 = true +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. @@ -178,45 +162,14 @@ sidebar_search_disable = false [params.ui.feedback] enable = true # 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 tell us how we can improve.' -no = 'Sorry to hear that. Please tell us how we can improve.' +yes = 'Glad to hear it! Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' # 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, +# 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 +# This section is needed even if it's left empty. [params.links] -# End user relevant links. These will show up on left side of footer and in the community page if you have one. -[[params.links.user]] - name = "Mailing list" - url = "https://groups.google.com/g/kubernetes-sig-cli" - icon = "fa fa-envelope" - desc = "Discussion and help from your fellow users" -[[params.links.user]] - name ="Twitter" - url = "https://example.org/twitter" - icon = "fab fa-twitter" - desc = "Follow us on Twitter to get the latest news!" -[[params.links.user]] - name = "Stack Overflow" - url = "https://example.org/stack" - icon = "fab fa-stack-overflow" - desc = "Practical questions and curated answers" -# Developer relevant links. These will show up on right side of footer and in the community page if you have one. -[[params.links.developer]] - name = "GitHub" - url = "https://github.com/google/docsy" - icon = "fab fa-github" - desc = "Development takes place here!" -[[params.links.developer]] - name = "Slack" - url = "https://example.org/slack" - icon = "fab fa-slack" - desc = "Chat with other project developers" -[[params.links.developer]] - name = "Developer mailing list" - url = "https://example.org/mail" - icon = "fa fa-envelope" - desc = "Discuss development issues around the project"