Skip to content

Commit

Permalink
docs/README: fix broken links
Browse files Browse the repository at this point in the history
Use absolute paths from the toplevel of the git repo instead of
relative paths because the README exists in the docs directory but
is symlinked from the toplevel of the repo.
  • Loading branch information
dustymabe committed Nov 20, 2019
1 parent 5795bb4 commit 136ef33
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,16 @@ One way to view the MCO is to treat the operating system itself as "just another
Kubernetes component" that you can inspect and manage with `oc`.

The MCO uses [CoreOS Ignition](https://github.com/coreos/ignition) as a configuration
format. Operating system updates use [rpm-ostree](http://github.com/projectatomic/rpm-ostree), with ostree updates encapsulated inside a container image. More information in [OSUpgrades.md](docs/OSUpgrades.md).
format. Operating system updates use [rpm-ostree](http://github.com/projectatomic/rpm-ostree), with ostree updates encapsulated inside a container image. More information in [OSUpgrades.md](/docs/OSUpgrades.md).

# Sub-components and design

This one git repository generates 4 components in a cluster; the `machine-config-operator`
pod manages the remaining 3 sub-components. Here are links to design docs:

- [machine-config-server](docs/MachineConfigServer.md)
- [machine-config-controller](docs/MachineConfigController.md)
- [machine-config-daemon](docs/MachineConfigDaemon.md)
- [machine-config-server](/docs/MachineConfigServer.md)
- [machine-config-controller](/docs/MachineConfigController.md)
- [machine-config-daemon](/docs/MachineConfigDaemon.md)

# Interacting with the MCO

Expand Down Expand Up @@ -136,21 +136,21 @@ a single MC apply to multiple labels, inline file encoding, etc.
# What to look at after creating a MachineConfig

Once you create a MachineConfig fragment like the above, the controller will generate a new "rendered" version that will be used as a target.
For more information, see [MachineConfiguration](docs/MachineConfiguration.md).
For more information, see [MachineConfiguration](/docs/MachineConfiguration.md).

In particular, you should look at `oc describe machineconfigpool` and `oc describe clusteroperator/machine-config` as noted above.

# More information about OS updates

The model implemented by the MCO is that the cluster controls the operating system. OS updates are just another entry in the release image. For more information, see [OSUpgrades.md](docs/OSUpgrades.md).
The model implemented by the MCO is that the cluster controls the operating system. OS updates are just another entry in the release image. For more information, see [OSUpgrades.md](/docs/OSUpgrades.md).

# Developing the MCO

See [HACKING.md](docs/HACKING.md).
See [HACKING.md](/docs/HACKING.md).

# Frequently Asked Questions

See [FAQ.md](docs/FAQ.md).
See [FAQ.md](/docs/FAQ.md).

# Security Response

Expand Down

0 comments on commit 136ef33

Please sign in to comment.