Skip to content

Commit

Permalink
Update broken links in docs
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Imeson <[email protected]>
  • Loading branch information
andrewimeson committed May 23, 2023
1 parent 4af6638 commit 37811b1
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/cloud-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ order to execute a short script that software provisions on startup.
The Cloud Init project supports multiple ways of supplying metadata and
userdata to a VMI. These methods are called **data sources**.

http://cloudinit.readthedocs.io/en/latest/topics/datasources.html
https://cloudinit.readthedocs.io/en/latest/reference/datasources.html

KubeVirt supports the different data source standards by taking the userdata
and metadata associated with a VMI and formatting that data in a way that
adheres to the specific datasource standard in use.

## NoCloud Data Source

http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html
https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html

The **NoCloud** data source involves generating an iso with userdata and
metadata in it, and attaching that iso the VMI instance. The fedora-atomic
Expand Down
2 changes: 1 addition & 1 deletion docs/devel/guest-os-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following Short IDs are currently supported:
| **win2k12r2** | Microsoft Windows Server 2012 R2 | 6.3 | winnt | http://microsoft.com/win/2k12r2 |
| **win2k16** | Microsoft Windows Server 2016 | 1709 | winnt | http://microsoft.com/win/2k16 |

For the updated list please refer to kubeVirt user guide - [Guest Operating System Information](https://kubevirt.gitbooks.io/user-guide/guest-os-info.html)
For the updated list please refer to kubeVirt user guide - [Guest Operating System Information](https://kubevirt.io/user-guide/virtual_machines/guest_operating_system_information/)


To get a full list of operating systems from Libosinfo database:
Expand Down
6 changes: 3 additions & 3 deletions docs/devel/olm-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ Travis cares for this on every release.

## Installing OLM on Kubernetes

- clone the [OLM repository](github.com/operator-framework/operator-lifecycle-manager)
- clone the [OLM repository](https://github.com/operator-framework/operator-lifecycle-manager)
- `cd deploy/upstream/quickstart`
- `kubectl apply -f olm.yaml`
>**Note:** if you get an error, try again, CRD creation might have been too slow
- check that the olm and catalog operators are running in the `olm` namespace

## Installing Marketplace on Kubernetes

- clone the [Marketplace repository](github.com/operator-framework/operator-marketplace)
- clone the [Marketplace repository](https://github.com/operator-framework/operator-marketplace)
- `cd deploy`
- `kubectl apply -f upstream/ --validate=false`
- check that the marketplace operator is running in the `marketplace` namespace
Expand All @@ -156,4 +156,4 @@ Travis cares for this on every release.

## Important

- the Quay repo name needs to match the package name (https://github.com/operator-framework/operator-marketplace/issues/122#issuecomment-470820491)
- the Quay repo name needs to match the package name (https://github.com/operator-framework/operator-marketplace/issues/122#issuecomment-470820491)
2 changes: 1 addition & 1 deletion docs/devel/virtual-machine.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Linking the created VirtualMachine to its parent VirtualMachine pose
a challenge. Using the same name is only part of the solution. To find the
parent VirtualMachine programmatically in the Kubernetes, the OwnerReference
is used. As described in the
[design document](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/controller-ref.md),
[design document](https://github.com/kubernetes/design-proposals-archive/blob/main/api-machinery/controller-ref.md),
the OwnerReference lives in the metadata section of the object and is created
automatically. Example:

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ First make sure you have `remote-viewer` installed. On Fedora run:
dnf install virt-viewer
```
Windows users can [download remote-viewer from virt-manager.org](https://virt-manager.org/download/), and may need
Windows users can [download remote-viewer from virt-manager.org](https://virt-manager.org/download.html), and may need
to add virt-viewer installation folder to their `PATH`.
Then, after you made sure that the VMI `vmi-ephemeral` is running, type:
Expand Down
2 changes: 1 addition & 1 deletion docs/iscsi-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This document describes how to associate a k8s secret with a VMI for the purpose
1. create a k8s secret containing the password and username fields.

The k8s secret must be formatted in the same way kubernetes performs iscsi
authentication for volumes. https://github.com/kubernetes/examples/blob/master/staging/volumes/iscsi/chap-secret.yaml
authentication for volumes. https://github.com/kubernetes/examples/blob/master/volumes/iscsi/chap-secret.yaml

```
cat << END > my-chap-secret.yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/quarantine.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,6 @@ test description in the code. After merging this PR the test will be out of
quarantine.

[1]: https://martinfowler.com/articles/nonDeterminism.html#Quarantine
[2]: https://www.thoughtworks.com/es/insights/blog/no-more-flaky-tests-go-team
[2]: https://www.thoughtworks.com/en-us/insights/blog/no-more-flaky-tests-go-team
[3]: https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html#quarantined-tests
[on testgrid]: https://testgrid.k8s.io/kubevirt-periodics
2 changes: 1 addition & 1 deletion docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ You must have 2 items before you can create a release.

1. **GPG key and passphrase files used for creating signed releases.**

[Instructions for adding GPG key to your github account](https://help.github.com/articles/adding-a-new-gpg-key-to-your-github-account)
[Instructions for adding GPG key to your github account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)

After adding the GPG key to github, export both the key and passphrase to files.
Be aware that this results in the key and passphrase being placed into a plain
Expand Down

0 comments on commit 37811b1

Please sign in to comment.