From ab54403d3cc1064e4a80dd77b8ced7cb4e11a1cb Mon Sep 17 00:00:00 2001 From: Spencer Brown Date: Fri, 1 Jan 2016 15:06:03 -0600 Subject: [PATCH] Documentation: Fix typos and errors in docs --- Documentation/api.md | 4 ++-- Documentation/bootcfg.md | 2 +- Documentation/config.md | 2 +- Documentation/getting-started.md | 4 ++-- Documentation/physical-hardware.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/api.md b/Documentation/api.md index c121c8ee..2fb19bb5 100644 --- a/Documentation/api.md +++ b/Documentation/api.md @@ -29,7 +29,7 @@ Finds the spec matching the hardware attribute query parameters and renders the **Response** #!ipxe - kernel /images/coreos/835.9.0/coreos_production_pxe.vmlinuz a=b coreos.autologin + kernel /images/coreos/835.9.0/coreos_production_pxe.vmlinuz cloud-config-url=http://172.17.0.2:8080/cloud?uuid=${uuid}&mac=${net0/mac:hexhyp} coreos.autologin initrd /images/coreos/835.9.0/coreos_production_pxe_image.cpio.gz boot @@ -60,7 +60,7 @@ Finds the spec matching the hardware attribute query parameters and renders the ## Cloud Config -Finds the spec matchin the hardware attribute query parameters and returns the specified cloud config file. Attributes are matched in priority order (UUID, MAC). +Finds the spec matching the hardware attribute query parameters and returns the specified cloud config file. Attributes are matched in priority order (UUID, MAC). GET http://bootcfg.example.com/cloud diff --git a/Documentation/bootcfg.md b/Documentation/bootcfg.md index 8ab82059..425eeda5 100644 --- a/Documentation/bootcfg.md +++ b/Documentation/bootcfg.md @@ -92,7 +92,7 @@ Here is a `machine.json` which embeds `"spec"` properties. "spec_id": "" } -and another``machine.json` which simplify references a `Spec` by id. +and another `machine.json` which simplify references a `Spec` by id. { "id": "074fbe06-94a9-4336-9e8a-20b6f81efb6c", diff --git a/Documentation/config.md b/Documentation/config.md index c94b3225..af6a479f 100644 --- a/Documentation/config.md +++ b/Documentation/config.md @@ -3,7 +3,7 @@ `bootcfg` arguments can be provided as flags or as environment variables. -| flag | varaible | example | +| flag | variable | example | |------|----------|---------| | -address | BOOTCFG_ADDRESS | 0.0.0.0:8080 | | -data-path | BOOTCFG_DATA_PATH | ./data | diff --git a/Documentation/getting-started.md b/Documentation/getting-started.md index 0d46b8e7..b0607874 100644 --- a/Documentation/getting-started.md +++ b/Documentation/getting-started.md @@ -13,7 +13,7 @@ The Preboot eXecution Environment (PXE) defines requirements for consistent, har At power-on, if a client machine's BIOS or UEFI boot firmware is set to perform network booting, the network interface card's PXE firmware broadcasts a DHCPDISCOVER packet identifying itself as a PXEClient to the network environment. -The network environment can be setup in a number of ways, which we'll discuss. In the simplest, a PXE-enabled DHCP Server responds with a DHCPOFFER with Options which include a TFTP server IP ("next server") and the name of an NBP ("boot filename") to download (e.g. pxelinux.0). PXE firmware downloads the NBP over TFTP and starts it load load configs, scripts, or images it required for installing an OS. +The network environment can be set up in a number of ways, which we'll discuss. In the simplest, a PXE-enabled DHCP Server responds with a DHCPOFFER with Options, which include a TFTP server IP ("next server") and the name of an NBP ("boot filename") to download (e.g. pxelinux.0). PXE firmware then downloads the NBP over TFTP and starts it. Then, the NBP loads configs, scripts, and/or images it requires to run an OS. ### Network Boot Programs @@ -68,7 +68,7 @@ boot A TFTP server is used only to provide the `undionly.kpxe` boot program to older PXE firmware in order to bootstrap into iPXE. -The [boot config service](bootcfg.md) can serve iPXE scripts to machines based on hardware attribtues. Setup involves configuring DHCP to send iPXE clients the correct boot script endpoint. +The [boot config service](bootcfg.md) can serve iPXE scripts to machines based on hardware attributes. Setup involves configuring DHCP to send iPXE clients the correct boot script endpoint. Continue to the [libvirt guide](virtual-hardware.md) or the [baremetal guide](physical-hardware.md) to use iPXE to boot PXE/iPXE client machines. Consult [CoreOS with iPXE](https://coreos.com/os/docs/latest/booting-with-ipxe.html) for details about CoreOS support for iPXE. diff --git a/Documentation/physical-hardware.md b/Documentation/physical-hardware.md index 662a195f..a603d011 100644 --- a/Documentation/physical-hardware.md +++ b/Documentation/physical-hardware.md @@ -46,7 +46,7 @@ If the DHCP server on your network is PXE-enabled and configurable, send the `bo Optionally, respond to older PXE client firmware with the location of the `undionly.kpxe` boot program on your TFTP server. -With `dnsmasq`, here is an example `dnsmask.conf` +With `dnsmasq`, here is an example `dnsmasq.conf` # dnsmasq.conf dhcp-range=192.168.1.1,192.168.1.254,30m