Bläddra i källkod

Fixing some doc headers

Antony Messerli 8 år sedan
förälder
incheckning
da958e9073

+ 2 - 2
docs/boot-drac.md

@@ -1,2 +1,2 @@
-### Dell DRAC
-TBA
+# Dell DRAC
+TBA

+ 2 - 2
docs/boot-ilo.md

@@ -1,2 +1,2 @@
-### HP iLO
-TBA
+# HP iLO
+TBA

+ 2 - 2
docs/boot-ipxe.md

@@ -1,6 +1,6 @@
-### iPXE
+# iPXE
 
-#### NIC with Embedded iPXE
+### NIC with Embedded iPXE
 
 If you've already compiled your own iPXE, you can load up the netboot.xyz menu easily by entering CTRL-B when prompted setting DHCP and then chainloading iPXE:
 

+ 4 - 4
docs/boot-iso.md

@@ -1,10 +1,10 @@
-### Booting from ISO
+# Booting from ISO
 
-#### Burning a CD/DVD
+### Burning a CD/DVD
 To create a bootable CD-ROM/DVD, burn the ISO image [netboot.xyz.iso](https://boot.netboot.xyz/ipxe/netboot.xyz.iso) to a blank CD-ROM/DVD.  Insert the media into the server, set the proper boot order and boot up.
 
-#### Virtual Machine Software
+### Virtual Machine Software
 You can also use these ISOs to boot any sort of VM in Citrix XenServer, VMware ESXi, VMware Fusion, VirtualBox. 
 
-#### Out of Band Virtual Media
+### Out of Band Virtual Media
 They are great for attaching to remote virtual media of a server like the Dell DRAC or HP iLOs.  Because the iPXE boot disk is so light weight, they are great for starting installations where there might be really low bandwidth.

+ 3 - 3
docs/boot-loaders.md

@@ -1,8 +1,8 @@
-### Boot as iPXE Linux Kernel
+# Boot as iPXE Linux Kernel
 
 The ipxe.lkrn file can be booted as a Linux kernel from the bootloader.  This can be useful for providing a diagnostic tool as part of the OS or even having a quick option to reprovision the server on the fly.
 
-#### Extlinux
+### Extlinux
 
 Edit /boot/extlinux.conf and add a simple entry:
 
@@ -12,6 +12,6 @@ Edit /boot/extlinux.conf and add a simple entry:
 
 The kernel is treated as a Linux kernel and the initrd is treated as the iPXE script that is run once the kernel has loaded.
 
-#### Grub
+### Grub
 
 

+ 4 - 4
docs/boot-tftp.md

@@ -1,8 +1,8 @@
-### Booting from DHCP and TFTP
+# Booting from DHCP and TFTP
 
 If you want to utilize netboot.xyz from your home or office network, it's relatively easy to set up.  It will allow all of your devices on your network to have netboot.xyz available whenever you need it by just changing the boot order on your device, selecting network boot, or manually selecting the device to boot.
 
-#### DHCP Server Setup
+### DHCP Server Setup
 You will have to tell your DHCP server to provide a "next-server", the address of a TFTP server on your network, and a "filename", the [netboot.xyz boot file](https://boot.netboot.xyz/ipxe/netboot.xyz.kpxe).  When your clients boot up, if they are set to network boot, they'll automatically get a valid DHCP address, pull down the netboot.xyz iPXE bootloader and load up the Operating System menu.  
 
 Example:
@@ -10,7 +10,7 @@ Example:
     next-server "1.2.3.4"
     filename "netboot.xyz.kpxe"
 
-#### TFTP Server Setup
+### TFTP Server Setup
 
 You will need to set up a tftp server to host the iPXE files.  There are various types of TFTP servers out there and they all usually work pretty well.  You can also use dnsmasq to host the files as well.
 
@@ -20,7 +20,7 @@ If you use dnsmasq you can add this configuration to /etc/dnsmasq.conf:
     tftp-root=/var/lib/tftp
     dhcp-boot=netboot.xyz.kpxe
 
-#### Regular and Undionly Boot Files
+### Regular and Undionly Boot Files
 
 If you experiencing issues with the regular [netboot.xyz.kpxe](https://boot.netboot.xyz/ipxe/netboot.xyz.kpxe) bootloader, you can try and use the [netboot.xyz-undionly.kpxe](https://boot.netboot.xyz/ipxe/netboot.xyz-undionly.kpxe) bootloader.  The regular bootloader includes common NIC drivers in the iPXE image, while the undionly loader will piggyback off the NIC boot firmware.
  

+ 3 - 3
docs/boot-usb.md

@@ -1,4 +1,4 @@
-### Booting from a USB Key
+# Booting from a USB Key
 
 *Warning: Backup your important data before using USB as it will overwrite anything on the USB key.*
 
@@ -6,7 +6,7 @@ Download a netboot.xyz USB disk:
 
 * [netboot.xyz](https://boot.netboot.xyz/ipxe/netboot.xyz.usb) 
 
-### Creating USB Key on Linux
+## Creating USB Key on Linux
 
 Insert a USB key in your compute and find the device name. Then use following command:
 
@@ -20,7 +20,7 @@ where sdX is your usb drive.
 
 The USB key should be ready to eject once finished.
 
-### Creating USB Key on OS X
+### Creating USB Key on MacOS
 
 __Run:__
 

+ 2 - 2
docs/boot-vbox.md

@@ -1,2 +1,2 @@
-### VirtualBox
-TBA
+# VirtualBox
+TBA

+ 3 - 3
docs/boot-vmware.md

@@ -1,10 +1,10 @@
-## Boot from VMware 
+# Boot from VMware 
 
 ### VMware Fusion
 
 These instructions are for setting up netboot.xyz in a VM on VMware's Fusion for MacOS.
 
-#### Create the VM
+### Create the VM
 
 * Add a new virtual machine.
 * Select "Install from disc or image".
@@ -15,7 +15,7 @@ These instructions are for setting up netboot.xyz in a VM on VMware's Fusion for
 
 This will create your VM.  
 
-#### Running the VM
+### Running the VM
 
 _You'll need to adjust the memory settings of the VM to ensure you'll have enough memory to run the OS installers in memory.  Typically it's good to bump the memory up to 2GB to 4GB._
 

+ 4 - 4
docs/faq.md

@@ -1,12 +1,12 @@
-## Frequently Asked Questions
+# Frequently Asked Questions
 
-### What is this?
+## What is this?
 netboot.xyz is tool that allows you to boot your favorite Operating System's installer or various utilities over the network with minimal overhead and all from a single menu system.  It's similar to various tools netbooting tools of the past like boot.kernel.org with a lot more flexibility.  The boot loader is very light weight being under 1MB in size which translates into a very quick time to create a USB key.
 
-### How does this work?
+## How does this work?
 netboot.xyz uses an open source tool called iPXE.  The bootloader used calls to a webserver that hosts that the iPXE source files.  The iPXE source files contain menus and logic that understand how the various Linux installers operate.  When you select an Operating System, netboot.xyz retrieves the images from the project directory when possible or known and trusted performant mirrors.  The location the file is pulled from is always displayed during retrieval.
 
-### Will my favorite distribution work?
+## Will my favorite distribution work?
 Usually you need three things to boot up an OS, the vmlinuz, the initramfs, and the rootfs.  Distributions that support an installer kernel hosted on a mirror are typically the easier ones to implement.  Distributions that only release as ISOs typically are harder to implement as we have to use memdisk to load it up into memory.  
 
 From [syslinux - memdisk](http://www.syslinux.org/wiki/index.php/MEMDISK): The majority of Linux based CD images will also fail to work with MEMDISK ISO emulation. Linux distributions require kernel and initrd files to be specified, as soon as these files are loaded the protected mode kernel driver(s) take control and the virtual CD will no longer be accessible. If any other files are required from the CD/DVD they will be missing, resulting in boot error(s). Linux distributions that only require kernel and initrd files function fully via ISO emulation, as no other data needs accessing from the virtual CD/DVD drive once they have been loaded. The boot loader has read all necessary files to memory by using INT 13h, before booting the kernel.

+ 1 - 1
docs/index.md

@@ -1,4 +1,4 @@
-## netboot.xyz 
+# netboot.xyz 
 [![Build Status](https://travis-ci.org/antonym/netboot.xyz.svg?branch=master)](https://travis-ci.org/antonym/netboot.xyz)
 
 ![netboot.xyz menu](img/netboot.xyz.gif)

+ 5 - 7
docs/usage-digitalocean.md

@@ -1,4 +1,4 @@
-### Digital Ocean
+# Digital Ocean
 
 [Digital Ocean](https://m.do.co/c/ab4e8f17ba0d) at one point had iPXE support loaded within their SeaBIOS but has since removed it.  In order to get around this, we'll have to rely on the Grub bootloader instead.
 
@@ -6,13 +6,11 @@ iPXE generates linux bootable kernels so that you can boot iPXE directly from Gr
 
 Tests were done using a [Fedora 23](https://getfedora.org) instance on [Digital Ocean](https://m.do.co/c/ab4e8f17ba0d).
 
-### Booting from Grub2
-
-#### Download an iPXE linux kernel
+### Download an iPXE linux kernel
 
 Obtain an iPXE generic kernel [here](https://boot.netboot.xyz/ipxe/generic-ipxe.lkrn) or [compile your own](http://ipxe.org/download) and save it to /boot/generic-ipxe.lkrn.
 
-#### Create a netboot.xyz initrd file
+### Create a netboot.xyz initrd file
 
 The netboot.xyz initrd file contains the script necessary to bring the instance on the network and reach out to netboot.xyz.
 
@@ -28,7 +26,7 @@ Save as /boot/netboot.xyz-initrd (replace your networking information where appr
     ifopen net0
     chain --autofree https://boot.netboot.xyz
 
-#### Add a Grub2 custom entry
+### Add a Grub2 custom entry
 
 Add the following entry to /etc/grub.d/40_custom:
 
@@ -39,7 +37,7 @@ Add the following entry to /etc/grub.d/40_custom:
         initrd16 /boot/netboot.xyz-initrd
     }
 
-#### Regenerate your grub config
+### Regenerate your grub config
 
 Run grub2-mkconfig right after editing the configuration to add the netboot.xyz entry to your grub menu:
 

+ 1 - 1
docs/usage-rackspace.md

@@ -1,4 +1,4 @@
-### Rackspace
+# Rackspace
 
 See [boot.rackspace.com](http://boot.rackspace.com) for now.  You can chain to netboot.xyz from there:
 

+ 1 - 1
docs/usage-vultr.md

@@ -1,4 +1,4 @@
-### Vultr
+# Vultr
 
 [Vultr](http://www.vultr.com/?ref=6870843) has some great support for using
 netboot.xyz right out of the box.