Skip to content

Commit b7c202b

Browse files
authored
chore(docs): add redirect, update slack URL, adjust styling (#2061)
* chore(docs): replace slack url * chore(readme): reorder slack URLs * chore(docs): remove duplication hugo mounts * chore(docs): update slack URL * chore(docs): add redirect to docs * chore(docs): reorder header links * chore(docs): remove color overrides * chore(docs): add intro
1 parent a6591cd commit b7c202b

File tree

8 files changed

+21
-67
lines changed

8 files changed

+21
-67
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,13 @@ Switching to Grafana Operator from traditional deployments amplifies your effici
9393
- Providing multi-architecture support, making it versatile across different platforms.
9494
- Offering one-click installation through Operatorhub/OLM.
9595
96-
## Get In Touch!
96+
## Get In Touch
9797
9898
Got questions or suggestions? Let us know! The quickest way to reach us is through our [GitHub Issues](https://github.com/grafana/grafana-operator/issues) or by joining our weekly public meeting on Mondays at 11:00 Central European (Summer) Time (09:00/10:00 UTC in Summer/Winter) (link [here](https://meet.google.com/spw-jtbk-mwj)).
9999
100100
Feel free to drop into our Grafana Operator discussions on:
101101
102-
[![Kubernetes Slack](https://img.shields.io/badge/kubernetes%20slack-white?logo=slack&logoColor=black)](https://kubernetes.slack.com/archives/C019A1KTYKC) [![Grafana Slack](https://img.shields.io/badge/grafana%20community%20Slack-4A254A?logo=slack&logoColor=white)](https://join.slack.com/t/grafana/shared_invite/zt-2eqidcplt-QzkxMuhZA4tGQeFQenE_MQ)
103-
104-
102+
[![Grafana Slack](https://img.shields.io/badge/grafana%20community%20Slack-4A254A?logo=slack&logoColor=white)](https://join.slack.com/t/grafana/shared_invite/zt-2eqidcplt-QzkxMuhZA4tGQeFQenE_MQ) [![Kubernetes Slack](https://img.shields.io/badge/kubernetes%20slack-white?logo=slack&logoColor=black)](https://kubernetes.slack.com/archives/C019A1KTYKC)
105103
106104
## Contributing
107105
@@ -113,7 +111,6 @@ For more information on how to contribute to the operator look at [CONTRIBUTING.
113111
> v4 will stop receiving bug fixes and security updates as of the 22nd of December 2023.
114112
> We recommend you migrate to v5 if you haven't yet! Please follow our [v4 -> v5 Migration Guide](https://grafana.github.io/grafana-operator/blog/2023/05/27/v4-to-v5-migration/) to mitigate any potential future risks.
115113
116-
117114
V5 is the current, actively developed and maintained version of the operator, which you can find on the
118115
***[Master Branch](https://github.com/grafana/grafana-operator/tree/master)***.
119116
@@ -144,15 +141,15 @@ With certain standards and approaches, we can provide a better user experience t
144141
145142
- Better designed Custom Resource Definitions (Upstream Grafana Native fields will be supported without having to
146143
whitelist them in the operator logic).
147-
- Upstream documentation can be followed to define the Grafana Operator Custom Resources.
148-
- This also means a change in API versions for the resources, but we see this as a benefit, our previous mantra of
144+
- Upstream documentation can be followed to define the Grafana Operator Custom Resources.
145+
- This also means a change in API versions for the resources, but we see this as a benefit, our previous mantra of
149146
maintaining a seamless upgrade from version to version, limited us in the changes we wanted to make for a long
150147
time.
151148
- A more streamlined Grafana resource management workflow, one that will be reflected across all controllers.
152149
- Using an upstream Grafana API client (standardizing our interactions with the Grafana API, moving away from bespoke
153150
logic).
154151
- The use of a more up-to-date Operator-SDK version, making use of newer features.
155-
- along with all relevant dependencies being kept up-to-date.
152+
- along with all relevant dependencies being kept up-to-date.
156153
- Proper testing.
157154
- Cleaning and cutting down on code.
158155
- Multi-instance and Multi-namespace support!

docs/_index.html

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,3 @@
1-
+++
2-
title = "Grafana-Operator"
3-
linkTitle = "grafana-operator"
4-
5-
+++
6-
7-
{{< blocks/cover title="Welcome to the Grafana Operator documentation" image_anchor="top" height="full" >}}
8-
<a class="btn btn-lg btn-primary me-3 mb-4" href="docs/">
9-
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
10-
</a>
11-
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/grafana/grafana-operator/releases">
12-
Releases <i class="fab fa-github ms-2 "></i>
13-
</a>
14-
<p class="lead mt-5">Manage Grafana resources through Kubernetes!</p>
15-
{{< blocks/link-down color="info" >}}
16-
{{< /blocks/cover >}}
17-
18-
19-
{{% blocks/lead color="primary" %}}
20-
The grafana-operator is a Kubernetes operator built to help you manage your Grafana instances in and outside of Kubernetes.
21-
22-
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.
23-
{{% /blocks/lead %}}
24-
25-
{{< blocks/section color="white" type="row" >}}
26-
{{% blocks/feature icon="fab fa-slack" title="Grafana-Operator slack" %}}
27-
Sign up for the [Kubernetes slack](https://slack.k8s.io/) today
28-
and join the [grafana-operator channel](https://kubernetes.slack.com/messages/grafana-operator/)
29-
to chat with maintainers and users.
30-
{{% /blocks/feature %}}
31-
32-
33-
{{% blocks/feature icon="fab fa-github" title="Contributions welcome" url="https://github.com/grafana/grafana-operator/blob/master/CONTRIBUTING.md" %}}
34-
Feel free to do a [Pull Request](https://github.com/grafana/grafana-operator/pulls) contributions workflow on **GitHub**. New contributors are always welcome!
35-
{{% /blocks/feature %}}
36-
37-
{{< /blocks/section >}}
1+
<head>
2+
<meta http-equiv="refresh" content="0; url=docs" />
3+
</head>

docs/about/_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
linkTitle: About
44
menu:
55
main:
6-
weight: 10
6+
weight: 30
77
---
88

99
{{< blocks/section >}}

docs/blog/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Docsy Blog"
33
linkTitle: "Blog"
44
menu:
55
main:
6-
weight: 30
6+
weight: 20
77
---
88

99

docs/blog/v5-getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,6 @@ Learned about the new concepts that we have introduced with the operator and hop
313313

314314
If you find any issues feel free to create one after reading through the existing once in v5 [labels](https://github.com/grafana/grafana-operator/labels/v5) to see all open issues.
315315

316-
To give feedback you can also join us in the [Kubernetes Slack](https://slack.k8s.io/) in the [grafana-operator channel](https://kubernetes.slack.com/messages/grafana-operator/).
316+
To give feedback you can also join us in the [Grafana Slack](https://grafana.slack.com) in the [grafana-operator channel](https://grafana.slack.com/messages/grafana-operator/).
317317

318318
And of course we are happy to receive PRs.

docs/docs/_index.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
---
22
title: "Introduction"
33
linkTitle: "Documentation"
4-
weight: 20
4+
weight: 10
55
menu:
66
main:
7-
weight: 20
7+
weight: 10
88
---
99

10-
The Grafana operator allows you to:
11-
* ⚙️ Deploy & Manage Grafana Instances inside of Kubernetes with ease
12-
* 🌐 Manage externally hosted instances using Kubernetes resources (for example Grafana Cloud)
10+
## What is Grafana Operator
1311

14-
To install the Grafana Operator in your Kubernetes cluster, Run the following command in your terminal:
12+
Grafana Operator is a Kubernetes operator built to help you manage your Grafana instances and its resources in and outside of Kubernetes.
1513

16-
```bash
17-
helm upgrade -i grafana-operator oci://ghcr.io/grafana/helm-charts/grafana-operator --version {{<param version>}}
18-
```
14+
Whether you’re running one Grafana instance or many, the Grafana Operator simplifies the processes of installing, configuring, and maintaining Grafana and its resources. Additionally, it's perfect for those who prefer to manage resources using infrastructure as code or using GitOps workflows through tools like ArgoCD and Flux CD.
1915

20-
For a detailed installation guide, refer to [the installation documentation]({{<relref installation>}}).
16+
## Ready to get started?
2117

22-
To get started, take a look at the [quick start guide]({{<relref quick-start.md>}}).
18+
To get started, take a look at the [quick start guide]({{< relref quick-start.md >}}).
19+
20+
For a detailed installation guide, please, refer to [the installation documentation]({{< relref installation >}}).
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-
$primary: #fd7e14;

hugo/config.yaml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,9 @@ params:
5151
- name: GitHub
5252
url: https://github.com/grafana/grafana-operator
5353
icon: fab fa-github
54-
desc: Development takes place here!
5554
- name: Slack
56-
url: https://kubernetes.slack.com/messages/grafana-operator/
55+
url: https://grafana.slack.com/messages/grafana-operator/
5756
icon: fab fa-slack
58-
desc: Chat with other grafana-operator users
5957
module:
6058
hugoVersion:
6159
extended: true
@@ -68,10 +66,6 @@ module:
6866
mounts:
6967
- source: ../docs
7068
target: content
71-
- source: ../docs
72-
target: content
73-
- source: ../examples
74-
target: content/docs/examples
7569
- source: ../examples
7670
target: content/docs/examples
7771
- source: ../deploy/helm/grafana-operator/README.md

0 commit comments

Comments
 (0)