Skip to content

Commit

Permalink
Documentation: fix broken links
Browse files Browse the repository at this point in the history
Signed-off-by: Damien Grisonnet <[email protected]>
  • Loading branch information
dgrisonnet committed Sep 22, 2020
1 parent 8aed16b commit 57f618b
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 24 deletions.
12 changes: 3 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ contribution. See the [DCO](DCO) file for details.

# Email and Chat

The project currently uses the general CoreOS email list and IRC channel:
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
The project currently uses the [Kubernetes Slack](https://slack.k8s.io/):
- [#prometheus-operator](https://kubernetes.slack.com/archives/CFFDS2Z7F)
- [#prometheus-operator-dev](https://kubernetes.slack.com/archives/C01B03QCSMN)

Please avoid emailing maintainers found in the MAINTAINERS file directly. They
are very busy and read the mailing lists.
Expand All @@ -40,12 +40,6 @@ This is a rough outline of what a contributor's workflow looks like:

Thanks for your contributions!

### Coding Style

CoreOS projects written in Go follow a set of style guidelines that we've documented
[here](https://github.com/coreos/docs/tree/master/golang). Please follow them when
working on your contributions.

### Format of the Commit Message

We follow a rough convention for commit messages that is designed to answer two
Expand Down
4 changes: 2 additions & 2 deletions Documentation/additional-scrape-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ NOTE: Use only one secret for ALL additional scrape configurations.

## Additional References

* [Prometheus Spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#prometheusspec)
* [Additional Scrape Configs](https://github.com/prometheus-operator/prometheus-operator/tree/master/example/additional-scrape-configs)
* [Prometheus Spec](api.md#prometheusspec)
* [Additional Scrape Configs](../example/additional-scrape-configs)
2 changes: 1 addition & 1 deletion Documentation/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ ProbeList is a list of Probes.

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| metadata | Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata | [metav1.ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#listmeta-v1-meta) | false |
| metadata | Standard list metadata More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata | [metav1.ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#listmeta-v1-meta) | false |
| items | List of Probes | []*[Probe](#probe) | true |

[Back to TOC](#table-of-contents)
Expand Down
2 changes: 1 addition & 1 deletion Documentation/custom-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</div>


**Deprecation Warning:** The _custom configuration_ option of the Prometheus Operator will be deprecated in favor of the [_additional scrape config_](./additional-scrape-config.md) option.
**Deprecation Warning:** The _custom configuration_ option of the Prometheus Operator will be deprecated in favor of the [_additional scrape config_](additional-scrape-config.md) option.


# Custom Configuration
Expand Down
10 changes: 5 additions & 5 deletions Documentation/thanos.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ _Note: This guide is valid for Prometheus Operator v0.28+ and Thanos v0.2+ and a
[Thanos](https://github.com/thanos-io/thanos/) is a set of components that can be composed into a highly available,
multi Prometheus metric system with potentially unlimited storage capacity, if your Object Storage allows for it.

Before continuing with Prometheus Operator Thanos integration, it is recommended to read more about Thanos in the [documentation](https://thanos.io/getting-started.md/).
Before continuing with Prometheus Operator Thanos integration, it is recommended to read more about Thanos in the [documentation](https://thanos.io/tip/thanos/getting-started.md/).

## What Prometheus Operator helps with?

Expand Down Expand Up @@ -117,14 +117,14 @@ The recording and alerting rules used by a `ThanosRuler` component, are configur
Deploying the sidecar was the first step towards getting Thanos up and running, but there are more components to be deployed, that complete Thanos:
- [Querier](https://thanos.io/components/query.md/)
- [Querier](https://thanos.io/tip/components/query.md/)
Additionally, when object storage backup is desired:
- [Store](https://thanos.io/components/store.md/)
- [Compactor](https://thanos.io/components/compact.md/)
- [Store](https://thanos.io/tip/components/store.md/)
- [Compactor](https://thanos.io/tip/components/compact.md/)
Again, take a look at the Thanos documentation for more details on these components: https://thanos.io/quick-tutorial.md
Again, take a look at the Thanos documentation for more details on these components: https://thanos.io/tip/thanos/quick-tutorial.md
kube-thanos project has already supported several thanos components.
For more details, please checkout [kube-thanos](https://github.com/thanos-io/kube-thanos/).
8 changes: 4 additions & 4 deletions Documentation/user-guides/monitoring-kubernetes-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This documentation is for an alpha feature.
</div>

# Monitoring Kubernetes Ingress with Ambassador
[Ambassador](https://www.getambassador.io/) is a popular open-source API gateway for Kubernetes. Built on [Envoy Proxy](https://www.envoyproxy.io), Ambassador natively exposes statistics that give you better insight to what is happening at the edge of your Kubernetes cluster. In this guide we will:
[Ambassador](https://getambassador.io/) is a popular open-source API gateway for Kubernetes. Built on [Envoy Proxy](https://envoyproxy.io), Ambassador natively exposes statistics that give you better insight to what is happening at the edge of your Kubernetes cluster. In this guide we will:

* Create a simple Kubernetes application
* Deploy Ambassador as your Kubernetes ingress controller
Expand All @@ -17,7 +17,7 @@ This documentation is for an alpha feature.
* The [Kubernetes command line tool](https://kubernetes.io/docs/tasks/tools/install-kubectl/)

## Deploy and Expose an Application on Kubernetes
First, we need an application running on Kubernetes for our users to access. You can deploy any application you would like but, for simplicity, we will use a [sample application](https://www.getambassador.io/user-guide/getting-started#3-creating-your-first-service) provided by the Ambassador team.
First, we need an application running on Kubernetes for our users to access. You can deploy any application you would like but, for simplicity, we will use a [sample application](https://getambassador.io/user-guide/getting-started#3-creating-your-first-service) provided by the Ambassador team.

We can quickly deploy this application using `kubectl`:

Expand Down Expand Up @@ -62,7 +62,7 @@ Now that we have an application running in Kubernetes, we need to expose it to t
3. Route traffic to your application
You configure Ambassador to expose your application using [annotations](https://www.getambassador.io/reference/configuration/) on the Kubernetes service of the application like the one below.
You configure Ambassador to expose your application using [annotations](https://getambassador.io/reference/configuration/) on the Kubernetes service of the application like the one below.
```yaml
---
Expand Down Expand Up @@ -194,4 +194,4 @@ Envoy's metrics data model is remarkably similar to that of Prometheus and uses
| envoy_cluster_upstream_rq | envoy_cluster_upstream_rq <br></br> envoy_cluster_upstream_rq_xx <br></br> envoy_cluster_upstream_rq_total <br></br> envoy_cluster_upstream_rq_retry | Statistics regarding traffic from Envoy to each upstream service. Tracking this will give you insight to how the request is performing after reaching Ambassador. It will help you pinpoint whether failures are happening in Ambassador or the upstream service. |


Envoy collects many more statistics including some regarding rate limiting, circuit breaking, and distributed tracing. See the [Envoy's documentation](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/stats) for more information on the metrics envoy collects.
Envoy collects many more statistics including some regarding rate limiting, circuit breaking, and distributed tracing. See the [Envoy's documentation](https://envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/stats) for more information on the metrics envoy collects.
2 changes: 1 addition & 1 deletion Documentation/user-guides/webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ configuration.
## Prerequisites

This guide assumes that you have already [deployed the Prometheus
Operator](Documentation/user-guides/getting-started.md) and that [admission
Operator](getting-started.md) and that [admission
controllers are
enabled](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#how-do-i-turn-on-an-admission-controller)
on your cluster.
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/monitoring/v1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1018,7 +1018,7 @@ type PodMonitorList struct {
type ProbeList struct {
metav1.TypeMeta `json:",inline"`
// Standard list metadata
// More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata
// More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata,omitempty"`
// List of Probes
Items []*Probe `json:"items"`
Expand Down

0 comments on commit 57f618b

Please sign in to comment.