forked from grafana/tempo-operator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* website documentation Signed-off-by: Ruben Vargas <[email protected]> * add tempo-operator slack to contributing Signed-off-by: Ruben Vargas <[email protected]> * change website base url default Signed-off-by: Ruben Vargas <[email protected]> * fix LICENCE and README.md links Signed-off-by: Ruben Vargas <[email protected]> --------- Signed-off-by: Ruben Vargas <[email protected]>
- Loading branch information
1 parent
152e8c5
commit 3b20257
Showing
43 changed files
with
6,827 additions
and
2,106 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [submodule "website/themes/doks"] | ||
| path = website/themes/doks | ||
| url = https://github.com/h-enk/doks.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| --- | ||
| title: Adopters | ||
| lead: "" | ||
| date: 2021-04-30T10:40:00+00:00 | ||
| lastmod: 2021-04-30T10:40:00+00:00 | ||
| draft: false | ||
| images: [] | ||
| --- | ||
|
|
||
| <!-- | ||
| Insert your entry using this template keeping the list alphabetically sorted: | ||
| ## <Company/Organization Name> | ||
| https://our-link.com/ | ||
| Environments: AWS, Azure, Google Cloud, Bare Metal, etc | ||
| Details (optional): | ||
| - Ruler for Tempostack | ||
| --> | ||
|
|
||
| This document tracks people and use cases for the Tempo Operator in production. By creating a list of production use cases we hope to build a community of advisors that we can reach out to with experience using various the Tempo Operator applications, operation environments, and cluster sizes. The Tempo Operator development team may reach out periodically to check-in on how the Tempo Operator is working in the field and update this list. | ||
|
|
||
|
|
||
| ## Red Hat Inc | ||
|
|
||
| https://www.redhat.com | ||
|
|
||
| Environments: AWS, Azure, Google Cloud, Bare Metal, etc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| title: Contributing | ||
| description: How can I contribute to the Tempo Operator? | ||
| lead: "" | ||
| lastmod: "2021-03-08T08:48:57+00:00" | ||
| draft: false | ||
| images: [] | ||
| menu: | ||
| docs: | ||
| parent: prologue | ||
| weight: 200 | ||
| toc: true | ||
| --- | ||
|
|
||
| This project is licensed under the [AGPLv3 license](LICENSE) and accept | ||
| contributions via GitHub pull requests. This document outlines some of the | ||
| conventions on development workflow, contact points | ||
| and other resources to make it easier to get your contribution accepted. | ||
|
|
||
|
|
||
| # Contributor License Agreement | ||
|
|
||
| By contributing to this project you agree to the Contributor License Agreement. | ||
|
|
||
| # Email and Chat | ||
|
|
||
| The project currently uses the [Grafana Slack](https://grafana.slack.com): | ||
| - [#tempo-operator-dev](https://grafana.slack.com/archives/C0414EUU39A) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| - Fork the repository on GitHub | ||
| - Read the [README](README.md) for build and test instructions | ||
| - Play with the project, submit bugs, submit patches! | ||
|
|
||
| ## Contribution Flow | ||
|
|
||
| This is a rough outline of what a contributor's workflow looks like: | ||
|
|
||
| - Create a topic branch from where you want to base your work (usually `main`). | ||
| - Make commits of logical units. | ||
| - Push your changes to a topic branch in your fork of the repository. | ||
| - Make sure the tests pass, and add any new tests as appropriate. | ||
| - Submit a pull request to the original repository. | ||
|
|
||
| Thanks for your contributions! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| // Package v1alpha1 contains API Schema definitions for the config.tempo v1alpha1 API group. | ||
| // +kubebuilder:object:generate=true | ||
| // +groupName=config.tempo.grafana.com | ||
| package v1alpha1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| package tempo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| // Package v1alpha1 contains API Schema definitions for the tempo v1alpha1 API group. | ||
| // +kubebuilder:object:generate=true | ||
| // +groupName=tempo.grafana.com | ||
| package v1alpha1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| { | ||
| "hideMemberFields": [ | ||
| "TypeMeta" | ||
| ], | ||
| "hideTypePatterns": [ | ||
| "ParseError$", | ||
| "List$" | ||
| ], | ||
| "externalPackages": [ | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", | ||
| "docsURLTemplate": "https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/util/intstr\\.IntOrString$", | ||
| "docsURLTemplate": "https://pkg.go.dev/k8s.io/apimachinery/pkg/util/intstr#IntOrString" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", | ||
| "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/apiextensions-apiserver/pkg/apis/apiextensions/v1\\.JSON$", | ||
| "docsURLTemplate": "https://pkg.go.dev/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1#JSON" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^github\\.com/os-observability/tempo-operator/apis/tempo/v1alpha1", | ||
| "docsURLTemplate": "../v1/api.md#tempo.grafana.com/v1alpha1.{{ .TypeIdentifier}}" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^github\\.com/os-observability/tempo-operator/apis/config/v1alpha1", | ||
| "docsURLTemplate": "../v1/feature-gates.md#tempo-grafana-com-v1alpha1-{{ .TypeIdentifier}}" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^k8s\\.io/component-base/config/v1alpha1\\.LeaderElectionConfiguration$", | ||
| "docsURLTemplate": "https://pkg.go.dev/k8s.io/component-base/config#LeaderElectionConfiguration" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^sigs\\.k8s\\.io/controller-runtime/pkg/config/v1alpha1\\.ControllerConfigurationSpec$", | ||
| "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerConfigurationSpec" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^sigs\\.k8s\\.io/controller-runtime/pkg/config/v1alpha1\\.ControllerMetrics$", | ||
| "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerMetrics" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^sigs\\.k8s\\.io/controller-runtime/pkg/config/v1alpha1\\.ControllerHealth$", | ||
| "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerHealth" | ||
| }, | ||
| { | ||
| "typeMatchPrefix": "^sigs\\.k8s\\.io/controller-runtime/pkg/config/v1alpha1\\.ControllerWebhook$", | ||
| "docsURLTemplate": "https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerWebhook" | ||
| } | ||
| ], | ||
| "typeDisplayNamePrefixOverrides": { | ||
| "k8s.io/api/": "Kubernetes ", | ||
| "k8s.io/apimachinery/pkg/apis/": "Kubernetes ", | ||
| "k8s.io/component-base/config/": "Kubernetes ", | ||
| "sigs.k8s.io/controller-runtime/pkg/config/": "K8S Controller-runtime ", | ||
| "github.com/os-observability/tempo-operator/apis/tempo/v1alpha1": "Tempo Operator v1alpha1", | ||
| "github.com/os-observability/tempo-operator/apis/config/v1alpha1": "Feature Gates" | ||
| }, | ||
| "markdownDisabled": false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| {{ define "member" }} | ||
| {{ if not (hiddenMember .)}} | ||
| {{ if fieldEmbedded . }} | ||
| {{ range .Type.Members }} | ||
| {{ template "member" . }} | ||
| {{ end }} | ||
| {{ else }} | ||
| <tr> | ||
| <td> | ||
| <code>{{ fieldName . }}</code><br/> | ||
| <em> | ||
| {{ if linkMDForType .Type }} | ||
| <a href="{{ linkMDForType .Type }}"> | ||
| {{ typeDisplayName .Type }} | ||
| </a> | ||
| {{ else }} | ||
| {{ typeDisplayName .Type }} | ||
| {{ end }} | ||
| </em> | ||
| </td> | ||
| <td> | ||
| {{ if isOptionalMember .}} | ||
| <em>(Optional)</em> | ||
| {{ end }} | ||
|
|
||
| {{ safe (renderComments .CommentLines) }} | ||
|
|
||
| {{ if and (eq (.Type.Name.Name) "ObjectMeta") }} | ||
| Refer to the Kubernetes API documentation for the fields of the | ||
| <code>metadata</code> field. | ||
| {{ end }} | ||
|
|
||
| </td> | ||
| </tr> | ||
| {{ end }} | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| {{ define "members" }} | ||
|
|
||
| {{ range .Members }} | ||
| {{ template "member" . }} | ||
| {{ end }} | ||
|
|
||
| {{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| {{ define "packages" }} | ||
| --- | ||
| title: "API" | ||
| description: "Generated API docs for the Tempo Operator" | ||
| lead: "" | ||
| draft: false | ||
| images: [] | ||
| menu: | ||
| +docs: | ||
| +parent: "operator" | ||
| weight: 1000 | ||
| toc: true | ||
| --- | ||
|
|
||
| This Document contains the types introduced by the Tempo Operator to be consumed by users. | ||
|
|
||
| > This page is automatically generated with `gen-crd-api-reference-docs`. | ||
|
|
||
| {{ range .packages }} | ||
| # {{ packageDisplayName . }} { #{{packageMDAnchorID . }} } | ||
| {{ with (index .GoPackages 0 )}} | ||
| {{ with .DocComments }} | ||
| <div> | ||
| {{ safe (renderComments .) }} | ||
| </div> | ||
| {{ end }} | ||
| {{ end }} | ||
|
|
||
| <b>Resource Types:</b> | ||
|
|
||
| {{ range (visibleTypes (sortedTypes .Types))}} | ||
| {{ template "type" . }} | ||
| {{ end }} | ||
| <hr/> | ||
| +newline | ||
| {{ end }} | ||
|
|
||
| {{ end }} | ||
|
|
Oops, something went wrong.