Skip to content

Commit

Permalink
#753 other title improvements (#1050)
Browse files Browse the repository at this point in the history 
* vagrant quickstart retitled for consistency

* rm number from title

* 2. rm number from title

* 3. rm number from title (Istio related, as were 2 prev)

* 4. rm number from title (Istio related)

* 5. rm number from title (Istio related)

* 6. rm number from title (Istio related)

* making backup 'examples' title more specific

* rewrite + making monitoring 'examples' title more specific

* suggestions from Btat

correcting capitalization for github, combining two lines into one

* versioning previous commit

* applying sunil's suggestions

rm'ing numbers from titles of pages missed in 2.0-2.4

* Apply suggestions from code review

Co-authored-by: Billy Tat <[email protected]>

---------

Co-authored-by: Billy Tat <[email protected]>
  • Loading branch information
@martyav @btat
martyav and btat authored Jan 17, 2024
1 parent 95604bb commit 2302e37
Show file tree
Hide file tree
Showing 53 changed files with 83 additions and 83 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 6. Generate and View Traffic
title: Generate and View Traffic from Istio
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 4. Set up the Istio Gateway
title: Set up the Istio Gateway
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 5. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 3. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference-guides/backup-restore-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Backup and Restore Examples
---

<head>
Expand Down
14 changes: 7 additions & 7 deletions docs/reference-guides/monitoring-v2-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Monitoring V2 Configuration Examples
---

<head>
Expand All @@ -8,20 +8,20 @@ title: Examples

### ServiceMonitor

An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml)
See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML.

### PodMonitor

An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor.

### PrometheusRule

For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).

For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources.
For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources.

An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule.

### Alertmanager Config

For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs).
See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs).
2 changes: 1 addition & 1 deletion ...on-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 7. Generate and View Traffic
title: Generate and View Traffic
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 3. Select the Nodes Where Istio Components Will be Deployed
title: Select the Nodes Where Istio Components Will be Deployed
---

> **Prerequisite:** Your cluster needs a worker node that can designated for Istio. The worker node should meet the [resource requirements.](../../../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md)
Expand Down
2 changes: 1 addition & 1 deletion ....4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 5. Set up the Istio Gateway
title: Set up the Istio Gateway
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 6. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 4. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...ersion-2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 6. Generate and View Traffic
title: Generate and View Traffic from Istio
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ....5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 4. Set up the Istio Gateway
title: Set up the Istio Gateway
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 5. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...n-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 3. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...oned_docs/version-2.5/reference-guides/backup-restore-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Backup and Restore Examples
---

<head>
Expand Down
14 changes: 7 additions & 7 deletions ...ioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Monitoring V2 Configuration Examples
---

<head>
Expand All @@ -8,20 +8,20 @@ title: Examples

### ServiceMonitor

An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml)
See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML.

### PodMonitor

An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor.

### PrometheusRule

For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).

For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources.
For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources.

An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule.

### Alertmanager Config

For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs).
See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs).
2 changes: 1 addition & 1 deletion ...ersion-2.6/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 6. Generate and View Traffic
title: Generate and View Traffic from Istio
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ....6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 4. Set up the Istio Gateway
title: Set up the Istio Gateway
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 5. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...n-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 3. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...oned_docs/version-2.6/reference-guides/backup-restore-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Backup and Restore Examples
---

<head>
Expand Down
14 changes: 7 additions & 7 deletions ...ioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Monitoring V2 Configuration Examples
---

<head>
Expand All @@ -8,20 +8,20 @@ title: Examples

### ServiceMonitor

An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml)
See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML.

### PodMonitor

An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor.

### PrometheusRule

For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).

For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources.
For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources.

An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md)
See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule.

### Alertmanager Config

For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs).
See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs).
2 changes: 1 addition & 1 deletion ...ersion-2.7/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Vagrant Quick Start
title: Rancher Vagrant Quick Start
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 1. Enable Istio in the Cluster
title: Enable Istio in the Cluster
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 2. Enable Istio in a Namespace
title: Enable Istio in a Namespace
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 6. Generate and View Traffic
title: Generate and View Traffic from Istio
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ....7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 4. Set up the Istio Gateway
title: Set up the Istio Gateway
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...w-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 5. Set up Istio's Components for Traffic Management
title: Set up Istio's Components for Traffic Management
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...n-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 3. Add Deployments and Services with the Istio Sidecar
title: Add Deployments and Services with the Istio Sidecar
---

<head>
Expand Down
2 changes: 1 addition & 1 deletion ...oned_docs/version-2.7/reference-guides/backup-restore-configuration/examples.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Examples
title: Backup and Restore Examples
---

<head>
Expand Down
Loading

0 comments on commit 2302e37

Please sign in to comment.