Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refresh home page #1722

Merged
merged 2 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
22 changes: 10 additions & 12 deletions docs/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,15 @@

+++

{{< blocks/cover title="Grafana-Operator: A Kubernetes operator to manage Grafana instances!" image_anchor="top" height="full" color="orange" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/grafana/grafana-operator">
Download <i class="fab fa-github ml-2 "></i>
</a>
<p></p>
{{< blocks/link-down color="info" >}}
</div>
{{< blocks/cover title="Welcome to the Grafana Operator documentation" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/grafana/grafana-operator/releases">
Releases <i class="fab fa-github ms-2 "></i>
</a>
<p class="lead mt-5">Manage Grafana resources through Kubernetes!</p>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}


Expand All @@ -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/)
Expand Down
14 changes: 3 additions & 11 deletions docs/about/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,9 @@ <h2>Creation</h2>

<h2>Current</h2>
<p>
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.
</p>

<br>
<h2>Future</h2>
<p>
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.
</p>

</div>
Expand Down
1 change: 0 additions & 1 deletion docs/docs/examples

This file was deleted.

1 change: 0 additions & 1 deletion docs/docs/installation/helm.md

This file was deleted.

1 change: 1 addition & 0 deletions hugo/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$primary: #fd7e14;
146 changes: 0 additions & 146 deletions hugo/config.toml

This file was deleted.

78 changes: 78 additions & 0 deletions hugo/config.yaml
Original file line number Diff line number Diff line change
@@ -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 <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>.
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
1 change: 0 additions & 1 deletion hugo/content

This file was deleted.

4 changes: 2 additions & 2 deletions hugo/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
14 changes: 8 additions & 6 deletions hugo/go.sum
Original file line number Diff line number Diff line change
@@ -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=
Loading