Skip to content

Commit

Permalink
Merge pull request #802 from sgreene570/doc-misc-cleanup
Browse files Browse the repository at this point in the history
Docs: Fix dead links in docs (and some typos)
  • Loading branch information
openshift-merge-robot committed May 29, 2019
2 parents 28587d8 + 7d3bbb8 commit fb707ca
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/HACKING.md
Expand Up @@ -86,7 +86,7 @@ We follow a hard flattening approach; i.e. direct and inherited dependencies are

Dependencies are managed with [dep](https://golang.github.io/dep/) but committed directly to the repository. If you don't have dep, install the latest release from [Installation](https://golang.github.io/dep/docs/installation.html) link.

We require atleast following version for dep:
We require at least the following versions for dep:

```
dep:
Expand Down Expand Up @@ -120,7 +120,7 @@ oc patch daemonset/machine-config-daemon --type='json' -p='[{"op": "add", "path"
```

You can replace `daemonset/machine-config-daemon` with any other MCO component.
If the componenet already has a `--v=` flag set, the command above still adds
If the component already has a `--v=` flag set, the command above still adds
verbose and ignores the previous one already set.
If you watch the pods, you'll notice your component restarting as well.
Note this still requires [disabling the CVO](https://github.com/openshift/cluster-version-operator/blob/master/docs/dev/clusterversion.md#disabling-the-cluster-version-operator).
Expand Down Expand Up @@ -181,7 +181,7 @@ runs in the https://api.ci.openshift.org/ cluster.
When a PR is complete you'll see a lot of information more nicely rendered, including
artifacts. The `pods/` directory for example has the logs for the various
pods. Lists of some important objects are extracted to JSON; for example `nodes.json` has
a list of the node state. For this project, the the `machineconfigs.json` and `machineconfigpools.json`
a list of the node state. For this project, the `machineconfigs.json` and `machineconfigpools.json`
are commonly useful.

## Logging into a cluster live
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Expand Up @@ -39,7 +39,7 @@ Because the MCO is an integrated operator, you can inspect its status
just like any other operator. If it's reporting success, then that
means that the operating system is up to date.

`oc describe clusteroperator/machine-config-operator`
`oc describe clusteroperator/machine-config`

One level down from the operator CRD, the `machineconfigpool` objects
track updates to a group of nodes. You will often want to run a command
Expand Down Expand Up @@ -134,7 +134,7 @@ 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](doc/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.

Expand All @@ -150,4 +150,4 @@ See [HACKING.md](docs/HACKING.md).

If you've found a security issue that you'd like to disclose confidentially
please contact Red Hat's Product Security team. Details at
https://access.redhat.com/security/team/contact
https://access.redhat.com/security/team/contact

0 comments on commit fb707ca

Please sign in to comment.