Skip to content

Commit

Permalink
Fix broken formatting in Installing guide (#4917)
Browse files Browse the repository at this point in the history
* Task1 done

“Installing Istio without sidecar injection(Recommended default installation)” added a space before the opening parenthesis.

* Task 2 

Correct formatting uses the opening tip tag (!!! tip), followed by a new line, and then 4 spaces before the tip text.

* Task 4

 Task fixed: https://knative.dev/docs/install/uninstall/#uninstalling-optional-serving-extensions Broken numbering in the "TLS with cert-manager" tab. To fix, check for the correct indentation of the code snippet (8 spaces).

* Task 5

Task fixed:  https://knative.dev/docs/install/uninstall/#uninstalling-optional-eventing-extensions broken numbering in Apace Kafka sink tab. To fix, check for the correct indentation of the code snippet (8 spaces).

* Task 3

Task fixed:  https://knative.dev/docs/install/upgrade/upgrade-installation-with-operator/#rollback-to-an-earlier-version tab formatting is broken. To fix, indent the lines 126-146 and 150-170 by an extra 4 spaces.

* changed the spacing according to the suggestion

Co-authored-by: Samia Nneji <snneji@vmware.com>

Co-authored-by: Samia Nneji <snneji@vmware.com>
  • Loading branch information
Subhasish-Behera and snneji authored Apr 15, 2022
1 parent 670d4c3 commit a1dcbc6
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 47 deletions.
8 changes: 4 additions & 4 deletions docs/install/installing-istio.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ cover a few useful Istio configurations and their benefits.

You can install Istio with or without a service mesh:

- [Installing Istio without sidecar injection](#installing-istio-without-sidecar-injection)(Recommended
- [Installing Istio without sidecar injection](#installing-istio-without-sidecar-injection) (Recommended
default installation)

- [Installing Istio with sidecar injection](#installing-istio-with-sidecar-injection)
Expand Down Expand Up @@ -159,9 +159,9 @@ all of the pods show a `STATUS` of `Running` or `Completed`:
```bash
kubectl get pods --namespace istio-system
```

> Tip: You can append the `--watch` flag to the `kubectl get` commands to view
> the pod status in realtime. You use `CTRL + C` to exit watch mode.
!!! tip
You can append the `--watch` flag to the `kubectl get` commands to view
the pod status in realtime. You use `CTRL + C` to exit watch mode.

### Configuring DNS

Expand Down
18 changes: 9 additions & 9 deletions docs/install/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ Uninstall any Serving extensions you have installed by performing the steps in t

1. Uninstall the component that integrates Knative with cert-manager:

```bash
kubectl delete -f {{ artifact( repo="net-certmanager", file="release.yaml") }}
```
```bash
kubectl delete -f {{ artifact( repo="net-certmanager", file="release.yaml") }}
```

1. Optional: if you no longer need cert-manager, uninstall it by following the steps in the
[cert-manager documentation](https://cert-manager.io/docs/installation/uninstall/kubernetes/).
Expand Down Expand Up @@ -133,15 +133,15 @@ Uninstall any Eventing extensions you have installed by following the relevant p

1. Uninstall the Kafka Sink data plane:

```bash
kubectl delete -f {{ artifact(org="knative-sandbox", repo="eventing-kafka-broker", file="eventing-kafka-sink.yaml") }}
```
```bash
kubectl delete -f {{ artifact(org="knative-sandbox", repo="eventing-kafka-broker", file="eventing-kafka-sink.yaml") }}
```

1. Uninstall the Kafka controller:

```bash
kubectl delete -f {{ artifact(org="knative-sandbox", repo="eventing-kafka-broker", file="eventing-kafka-controller.yaml") }}
```
```bash
kubectl delete -f {{ artifact(org="knative-sandbox", repo="eventing-kafka-broker", file="eventing-kafka-controller.yaml") }}
```



Expand Down
68 changes: 34 additions & 34 deletions docs/install/upgrade/upgrade-installation-with-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,48 +123,48 @@ If the upgrade fails, you can rollback to restore your Knative to the previous v

=== "Knative Serving"

To rollback to a previous version of Knative Serving:
To rollback to a previous version of Knative Serving:

1. Create a YAML file containing the following:
1. Create a YAML file containing the following:

```yaml
apiVersion: operator.knative.dev/v1alpha1
kind: KnativeServing
metadata:
name: knative-serving
namespace: knative-serving
spec:
version: "<previous-version>"
```
Where `<previous-version>` is the Knative version that you want to downgrade to.
```yaml
apiVersion: operator.knative.dev/v1alpha1
kind: KnativeServing
metadata:
name: knative-serving
namespace: knative-serving
spec:
version: "<previous-version>"
```
Where `<previous-version>` is the Knative version that you want to downgrade to.

1. Apply the YAML file by running the command:
1. Apply the YAML file by running the command:

```bash
kubectl apply -f <filename>.yaml
```
Where `<filename>` is the name of the file you created in the previous step.
```bash
kubectl apply -f <filename>.yaml
```
Where `<filename>` is the name of the file you created in the previous step.

=== "Knative Eventing"

To rollback to a previous version of Knative Eventing:
To rollback to a previous version of Knative Eventing:

1. Create a YAML file containing the following:
1. Create a YAML file containing the following:

```yaml
apiVersion: operator.knative.dev/v1alpha1
kind: KnativeEventing
metadata:
name: knative-eventing
namespace: knative-eventing
spec:
version: "<previous-version>"
```
Where `<previous-version>` is the Knative version that you want to downgrade to.
```yaml
apiVersion: operator.knative.dev/v1alpha1
kind: KnativeEventing
metadata:
name: knative-eventing
namespace: knative-eventing
spec:
version: "<previous-version>"
```
Where `<previous-version>` is the Knative version that you want to downgrade to.

1. Apply the YAML file by running the command:
1. Apply the YAML file by running the command:

```bash
kubectl apply -f <filename>.yaml
```
Where `<filename>` is the name of the file you created in the previous step.
```bash
kubectl apply -f <filename>.yaml
```
Where `<filename>` is the name of the file you created in the previous step.

0 comments on commit a1dcbc6

Please sign in to comment.