浏览代码

Lots of doc tweaks, using mkdocs for gh-pages

Antony Messerli 9 年之前
父节点
当前提交
9a571b7804
共有 7 个文件被更改,包括 71 次插入48 次删除
  1. 17 0
      docs/boot_ipxe.md
  2. 3 0
      docs/boot_iso.md
  3. 3 3
      docs/boot_loaders.md
  4. 20 0
      docs/boot_usb.md
  5. 17 42
      docs/index.md
  6. 5 0
      docs/usage_rackspace.md
  7. 6 3
      mkdocs.yml

+ 17 - 0
docs/boot_ipxe.md

@@ -0,0 +1,17 @@
+### 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:
+
+    dhcp
+    chain http://boot.netboot.xyz/menu.ipxe
+
+If you don't have DHCP on your network, you can manually set your network information:
+
+    set net0/ip <ip>
+    set net0/netmask <netmask>
+    set net0/gateway <gateway>
+    set dns <nameserver>
+    ifopen net0
+    chain http://boot.netboot.xyz/menu.ipxe

+ 3 - 0
docs/boot_iso.md

@@ -0,0 +1,3 @@
+### Booting from ISO
+
+To create a bootable CD-ROM, burn the ISO image ipxe.iso (~1MB in size) to a blank CD-ROM.  You can also use this ISO file as a virtual CD device in Citrix XenServer, VMware ESXi, VMware Fusion, VirtualBox, or even in a Dell DRAC or HP iLOs virtual CD drive.

+ 3 - 3
docs/boot_loaders.md

@@ -1,8 +1,8 @@
-### Boot as a Linux Kernel from Extlinux or Grub
+### 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.
 
-#### Booting from 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.
 
-#### Booting from Grub
+#### Grub
 
 

+ 20 - 0
docs/boot_usb.md

@@ -0,0 +1,20 @@
+### Boot from iPXE USB
+
+*Warning: Backup your important data before using USB as it will overwrite anything on the USB key.*
+
+Download a netboot.xyz disk:
+
+* [dhcp](http://boot.netboot.xyz/ipxe/netboot.xyz-dhcp.usb) - Automatically detects your networking
+* [static](http://boot.netboot.xyz/ipxe/netboot.xyz-static.usb) - Prompts for manual entry of your networking information
+
+Insert a USB key in your compute and find the device name. Then use following command:
+
+    cat ipxe.usb > /dev/sdX
+
+or
+
+    dd if=ipxe.usb of=/dev/sdX
+
+where sdX is your usb drive.
+
+Reboot and set your BIOS to load the USB key first if it's not set for that already.  You should see iPXE load up either load up netboot.xyz automatically or prompt you to set your networking information up.

+ 17 - 42
docs/index.md

@@ -1,58 +1,29 @@
-## What is netboot.xyz?
+## netboot.xyz [![Build Status](https://travis-ci.org/antonym/netboot.xyz.svg?branch=master)](https://travis-ci.org/antonym/netboot.xyz) [![Join the chat at https://gitter.im/antonym/netboot.xyz](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/antonym/netboot.xyz?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ![netboot.xyz menu](img/netboot.xyz.gif)
 
-[netboot.xyz](http://www.netboot.xyz) is a convenient place to boot into any type of operating system or utility disk without the need of having to go spend time retrieving the ISO just to run it.  iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the OS you want along with any specific types of versions or bootable flags.
+### Bootloader Downloads
 
-You can remote attach the ISO to servers, set it up as a rescue option in Grub, or even set your home network to boot to it by default so that it's always available.
-
-### Getting started
-
-Grab these bootloaders and drop them into your favorite virtualization tool to start testing out netboot.xyz.  These are precompiled versions of the latest version of [iPXE](http://https://github.com/ipxe/ipxe) that will chainload you to [http://boot.netboot.xyz/menu.ipxe](http://boot.netboot.xyz/menu.ipxe).  There are two versions of each, one if you have DHCP on your network, and one if you have to set a static IP before connecting outside of your network.
+These are pregenerated iPXE disks that will automatically load [boot.netboot.xyz](http://boot.netboot.xyz).
 
 * ISO: [dhcp](http://boot.netboot.xyz/ipxe/netboot.xyz-dhcp.iso) | [static](http://boot.netboot.xyz/ipxe/netboot.xyz-static.iso)
 * USB: [dhcp](http://boot.netboot.xyz/ipxe/netboot.xyz-dhcp.usb) | [static](http://boot.netboot.xyz/ipxe/netboot.xyz-static.usb)
 * Kernel: [dhcp](http://boot.netboot.xyz/ipxe/netboot.xyz-dhcp.lkrn) | [static](http://boot.netboot.xyz/ipxe/netboot.xyz-static.lkrn)
 * Checksums: [SHA256](http://boot.netboot.xyz/ipxe/netboot.xyz-sha256-checksums.txt)
 
-If you already have iPXE up and running on the network, you can hit netboot.xyz at anytime by typing:
-
-    chain --autofree http://boot.netboot.xyz
-
-### Booting Methods
-#### 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:
-
-    dhcp
-    chain http://boot.netboot.xyz/menu.ipxe
-
-If you don't have DHCP on your network, you can manually set your network information:
+### What is netboot.xyz?
 
-    set net0/ip <ip>
-    set net0/netmask <netmask>
-    set net0/gateway <gateway>
-    set dns <nameserver>
-    ifopen net0
-    chain http://boot.netboot.xyz/menu.ipxe
+[netboot.xyz](http://www.netboot.xyz) is a way to select various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool.  iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the OS you want along with any specific types of versions or bootable flags.
 
-#### Boot from iPXE ISO
+You can remote attach the ISO to servers, set it up as a rescue option in Grub, or even set up your home network to boot to it by default so that it's always available.
 
-To create a bootable CD-ROM, burn the ISO image ipxe.iso (~1MB in size) to a blank CD-ROM.  You can also use this ISO file as a virtual CD device in Citrix XenServer, VMware ESXi, VMware Fusion, VirtualBox, or even in a Dell DRAC or HP iLOs virtual CD drive.
-
-#### Boot from iPXE USB
-
-*Warning: Backup your important data before using USB as it will overwrite anything on the USB key.*
-
-Insert a USB disk, find it's device name of USB. Then use following command:
-
-    cat ipxe.dsk > /dev/sdX
+### Getting started
 
-or
+Download the bootloader of your choice from the links above and add it to your favorite virtualization tool to start testing out netboot.xyz.  These are precompiled versions of the latest version of [iPXE](http://https://github.com/ipxe/ipxe) that will chainload you to [http://boot.netboot.xyz](http://boot.netboot.xyz).  There are two versions of each, one if you have DHCP on your network, and one if you have to set a static IP before connecting outside of your network.
 
-    dd if=ipxe.dsk of=/dev/sdX
+If you already have iPXE up and running on the network, you can hit netboot.xyz at anytime by typing:
 
-where sdX is your usb drive.  Substitute /dev/sdX for /dev/fd0 in the case of using a floppy.
+    chain --autofree http://boot.netboot.xyz
 
 ### Operating Systems
 
@@ -82,14 +53,18 @@ where sdX is your usb drive.  Substitute /dev/sdX for /dev/fd0 in the case of us
 * [Memtest](http://www.memtest.org/)
 * [Partition Wizard](http://www.partitionwizard.com)
 
+### Source Code
+
+The source code for netboot.xyz is located [here](https://github.com/antonym/netboot.xyz).
+
 ### Contributing
 
-Pull requests are welcome and encouraged.  Feel free to issue a pull request for new versions or tools that you might find useful.  Once merged into master, travis-ci will regenerate new versions of iPXE from upstream and deploy the latest changes to netboot.xyz.
+New version of an OS out?  Found a new OS that works well with iPXE?  Pull requests are welcomed and encouraged and helps me out a ton!  Feel free to issue a pull request for new versions or tools that you might find useful.  Once merged into master, [Travis CI](https://travis-ci.org/antonym/netboot.xyz) will regenerate new versions of [iPXE from upstream](https://github.com/ipxe/ipxe) and deploy the latest changes to netboot.xyz.
 
 ### Testing New Branches
 
-Under the Utilities menu on netboot.xyz, there's an option for "Test netboot.xyz branch".  If you've forked the code and have developed a new feature branch, you can use this option to chainload into that branch to test and validate the code.  All you need to do is specify your github user name and the name of your branch or abbreviated hash of the commit.
+Under the Utilities menu on netboot.xyz, there's an option for ["Test netboot.xyz branch"](https://github.com/antonym/netboot.xyz/blob/master/src/utils.ipxe#L61).  If you've forked the code and have developed a new feature branch, you can use this option to chainload into that branch to test and validate the code.  All you need to do is specify your github user name and the name of your branch or abbreviated hash of the commit.
 
 ### Feedback
 
-Feel free to open up an issue on github or contact me via <antony@mes.ser.li>.
+Feel free to open up an issue on github or contact me at <antony@mes.ser.li>.

+ 5 - 0
docs/usage_rackspace.md

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

+ 6 - 3
mkdocs.yml

@@ -6,11 +6,14 @@ docs_dir: docs
 google_analytics: ['UA-68807-15', 'netboot.xyz']
 pages:
 - Home: 'index.md'
-- Booting with...:
-    - 'Dell DRAC': 'boot_drac.md'
+- Boot from...:
     - 'Extlinux/Grub': 'boot_loaders.md'
-    - 'HP iLO': 'boot_ilo.md'
+    - 'iPXE': 'boot_ipxe.md'
+    - 'ISO': 'boot_iso.md'
+    - 'USB': 'boot_usb.md'
     - 'Virtual Box': 'boot_vbox.md'
     - 'VMware': 'boot_vmware.md'
 - Provider Usage:
     - 'Digital Ocean': 'usage_digitalocean.md'
+    - 'Rackspace': 'usage_rackspace.md'
+theme: flatly