From be66c6f40d5c6393e519a1bcbb5c5b4c83743c26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20S=C3=BC=C3=9F?= Date: Tue, 22 Oct 2024 15:53:49 +0200 Subject: [PATCH 1/2] docs: refresh home page --- .github/workflows/hugo.yaml | 2 +- docs/_index.html | 22 ++-- docs/about/_index.html | 14 +-- docs/docs/examples | 1 - docs/docs/installation/helm.md | 1 - hugo/assets/scss/_variables_project.scss | 1 + hugo/config.toml | 146 ----------------------- hugo/config.yaml | 78 ++++++++++++ hugo/content | 1 - hugo/go.mod | 4 +- hugo/go.sum | 14 ++- 11 files changed, 103 insertions(+), 181 deletions(-) delete mode 120000 docs/docs/examples delete mode 120000 docs/docs/installation/helm.md create mode 100644 hugo/assets/scss/_variables_project.scss delete mode 100644 hugo/config.toml create mode 100644 hugo/config.yaml delete mode 120000 hugo/content diff --git a/.github/workflows/hugo.yaml b/.github/workflows/hugo.yaml index bb470fe1c..4da0b704a 100644 --- a/.github/workflows/hugo.yaml +++ b/.github/workflows/hugo.yaml @@ -29,7 +29,7 @@ jobs: build: runs-on: ubuntu-latest env: - HUGO_VERSION: 0.111.2 + HUGO_VERSION: 0.134.3 steps: - name: Install Hugo CLI run: | diff --git a/docs/_index.html b/docs/_index.html index dbfe6c9be..0d01f64ae 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -4,17 +4,15 @@ +++ -{{< blocks/cover title="Grafana-Operator: A Kubernetes operator to manage Grafana instances!" image_anchor="top" height="full" color="orange" >}} -
- }}"> - Learn More - - - Download - -

- {{< blocks/link-down color="info" >}} -
+{{< blocks/cover title="Welcome to the Grafana Operator documentation" image_anchor="top" height="full" >}} + + Learn More + + + Releases + +

Manage Grafana resources through Kubernetes!

+{{< blocks/link-down color="info" >}} {{< /blocks/cover >}} @@ -24,7 +22,7 @@ We make it possible for you to manage and share Grafana dashboards, datasources etc. through code between multiple instances in an easy and scalable way. {{% /blocks/lead %}} -{{< blocks/section color="white" >}} +{{< blocks/section color="white" type="row" >}} {{% blocks/feature icon="fab fa-slack" title="Grafana-Operator slack" %}} Sign up for the [Kubernetes slack](https://slack.k8s.io/) today and join the [grafana-operator channel](https://kubernetes.slack.com/messages/grafana-operator/) diff --git a/docs/about/_index.html b/docs/about/_index.html index a34bafdf9..dddcda8dd 100644 --- a/docs/about/_index.html +++ b/docs/about/_index.html @@ -21,17 +21,9 @@

Creation

Current

-Currently the operator is maintained by four people from different companies among other from RedHat. -This is not part of any ones daily job and it's something that we do because we see an value in it for the community and we think that it's fun. -

- -
-

Future

-

-We hope that in the near future we will take on more maintainers especially after the big refactoring that we did for version 5. -We think that the code will be easier to read and thus easier to get started with. - -One of our future plans is to give a way the project to some bigger organization that could help to host the project. +Currently the operator is maintained by Grafana Labs and the original creators/maintainers. +While Grafana Labs maintains the operator, we do not offer any commercial support for it. +Support & Issue triage is done on a best-effor basis.

diff --git a/docs/docs/examples b/docs/docs/examples deleted file mode 120000 index da7b19653..000000000 --- a/docs/docs/examples +++ /dev/null @@ -1 +0,0 @@ -../../examples/ \ No newline at end of file diff --git a/docs/docs/installation/helm.md b/docs/docs/installation/helm.md deleted file mode 120000 index e7834f9ca..000000000 --- a/docs/docs/installation/helm.md +++ /dev/null @@ -1 +0,0 @@ -../../../deploy/helm/grafana-operator/README.md \ No newline at end of file diff --git a/hugo/assets/scss/_variables_project.scss b/hugo/assets/scss/_variables_project.scss new file mode 100644 index 000000000..85a72edfe --- /dev/null +++ b/hugo/assets/scss/_variables_project.scss @@ -0,0 +1 @@ +$primary: #fd7e14; diff --git a/hugo/config.toml b/hugo/config.toml deleted file mode 100644 index 7af3bb5b7..000000000 --- a/hugo/config.toml +++ /dev/null @@ -1,146 +0,0 @@ -baseURL = "/" -title = "grafana-operator" - -# Language settings -contentDir = "content" -#defaultContentLanguage = "en" - -enableRobotsTXT = true - -# Will give values to .Lastmod etc. -enableGitInfo = true - -# Highlighting config -pygmentsCodeFences = true -pygmentsUseClasses = false -# Use the new Chroma Go highlighter in Hugo. -pygmentsUseClassic = false -#pygmentsOptions = "linenos=table" -# See https://help.farbox.com/pygments.html -pygmentsStyle = "tango" - -# Configure how URLs look like per section. -[permalinks] -blog = "/:section/:year/:month/:day/:slug/" - -# Image processing configuration. -[imaging] -resampleFilter = "CatmullRom" -quality = 75 -anchor = "smart" - -[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] -copyright = "The Docsy Authors" -privacy_policy = "https://policies.google.com/privacy" - -# First one is picked as the Twitter card image if not set on page. -# images = ["images/project-illustration.png"] - -# 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" - -# 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 = "v5.14.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" - -# Repository configuration (URLs for in-page links to opening issues and suggesting changes) -github_repo = "https://github.com/grafana/grafana-operator" - -# Specify a value here if your content directory is not in your repo's root directory -github_subdir = "hugo" - -# 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" - -# Google Custom Search Engine ID. Remove or comment out to disable search. -# gcs_engine_id = "" - -# Enable Algolia DocSearch -algolia_docsearch = false - -# Enable Lunr.js offline search -offlineSearch = false - -# Enable syntax highlighting and copy buttons on code blocks with Prism -prism_syntax_highlighting = false - -# User interface configuration -[params.ui] -# 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 = true -# 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 = false -# 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 = 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 = 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 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, -# add "hide_readingtime: true" to the page's front matter -[params.ui.readingtime] -enable = false - -[params.links] -# 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://kubernetes.slack.com/messages/grafana-operator/" - icon = "fab fa-slack" - desc = "Chat with other grafana-operator users" - -# hugo module configuration -[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 - [[module.imports]] - path = "github.com/google/docsy/dependencies" - disable = false diff --git a/hugo/config.yaml b/hugo/config.yaml new file mode 100644 index 000000000..7ababda6f --- /dev/null +++ b/hugo/config.yaml @@ -0,0 +1,78 @@ +baseURL: / +title: grafana-operator +contentDir: content +enableRobotsTXT: true +enableGitInfo: true +pygmentsCodeFences: true +pygmentsUseClasses: false +pygmentsUseClassic: false +pygmentsStyle: tango +permalinks: + blog: /:section/:year/:month/:day/:slug/ +imaging: + resampleFilter: CatmullRom + quality: 75 + anchor: smart +markup: + goldmark: + renderer: + unsafe: true + highlight: + style: tango + noClasses: false +params: + copyright: Grafana Operator Team + version_menu: Releases + archived_version: false + version: v5.14.0 + url_latest_version: https://example.com + github_repo: https://github.com/grafana/grafana-operator + github_branch: master + path_base_for_github_subdir: + from: content/(.*?) + to: docs/$1 + offlineSearch: true + prism_syntax_highlighting: false + ui: + breadcrumb_disable: false + navbar_logo: true + navbar_translucent_over_cover_disable: true + sidebar_menu_compact: false + sidebar_search_disable: false + showLightDarkModeMenu: true + feedback: + enable: false + yes: Glad to hear it! Please tell us how we can improve. + no: Sorry to hear that. Please tell us how we can improve. + readingtime: + enable: false + links: + developer: + - name: GitHub + url: https://github.com/grafana/grafana-operator + icon: fab fa-github + desc: Development takes place here! + - name: Slack + url: https://kubernetes.slack.com/messages/grafana-operator/ + icon: fab fa-slack + desc: Chat with other grafana-operator users +module: + hugoVersion: + extended: true + min: 0.134.0 + imports: + - path: github.com/google/docsy + disable: false + - path: github.com/google/docsy/dependencies + disable: false + mounts: + - source: ../docs + target: content + - source: ../docs + target: content + - source: ../examples + target: content/docs/examples + - source: ../examples + target: content/docs/examples + - source: ../deploy/helm/grafana-operator/README.md + target: content/docs/installation/helm.md diff --git a/hugo/content b/hugo/content deleted file mode 120000 index a9594bfe4..000000000 --- a/hugo/content +++ /dev/null @@ -1 +0,0 @@ -../docs \ No newline at end of file diff --git a/hugo/go.mod b/hugo/go.mod index 77a846d26..4e397c4af 100644 --- a/hugo/go.mod +++ b/hugo/go.mod @@ -3,6 +3,6 @@ module github.com/grafana/grafana-operator/hugo go 1.19 require ( - github.com/google/docsy v0.6.0 // indirect - github.com/google/docsy/dependencies v0.6.0 // indirect + github.com/google/docsy v0.11.0 // indirect + github.com/google/docsy/dependencies v0.7.2 // indirect ) diff --git a/hugo/go.sum b/hugo/go.sum index 50aba44a4..7d2f09f13 100644 --- a/hugo/go.sum +++ b/hugo/go.sum @@ -1,6 +1,8 @@ -github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= -github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= -github.com/google/docsy/dependencies v0.6.0 h1:BFXDCINbp8ZuUGl/mrHjMfhCg+b1YX+hVLAA5fGW7Pc= -github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= -github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.11.0 h1:QnV40cc28QwS++kP9qINtrIv4hlASruhC/K3FqkHAmM= +github.com/google/docsy v0.11.0/go.mod h1:hGGW0OjNuG5ZbH5JRtALY3yvN8ybbEP/v2iaK4bwOUI= +github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI= +github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= +github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= From 832dbe4a446ffb1f42f7c989efb11bcdc32f8f3b Mon Sep 17 00:00:00 2001 From: Igor Beliakov Date: Tue, 22 Oct 2024 20:06:53 +0200 Subject: [PATCH 2/2] fix(workflows): hugo version in pr-hugo workflow --- .github/workflows/pr-hugo.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pr-hugo.yaml b/.github/workflows/pr-hugo.yaml index d9a0a3bfd..af8400c9b 100644 --- a/.github/workflows/pr-hugo.yaml +++ b/.github/workflows/pr-hugo.yaml @@ -12,7 +12,7 @@ jobs: build: runs-on: ubuntu-latest env: - HUGO_VERSION: 0.111.2 + HUGO_VERSION: 0.134.3 steps: - name: Install Hugo CLI run: |