Restructuring starter guide is about to start, content is now at leas…

…t legible

contact.rst

@@ -0,0 +1,45 @@
+Communication within the LEDE Project
+=====================================
+
+One of LEDE's goals is that all project-related communication should be done on public channels that are archived and easily browsable. However, specific problems and tasks may be resolved using direct means of communication. Please look through these choices to find an appropriate means to reach us.
+
+Forum
+-----
+
+The `LEDE Forum <https://forum.lede-project.org>`_ provides a place for direct member-to-member conversations about Installing and running LEDE; Requesting help with development questions; Discussing the documentation; and Publicizing community builds, new packages, and projects that use LEDE. Forum members can follow the discussion via the web, or optionally through email.
+
+Mailing Lists
+-------------
+
+The project offers the following mailing lists:
+
+  - `lede-dev@lists.infradead.org <https://lists.infradead.org/mailman/listinfo/lede-dev>`_ - Use this list for submitting patches and general development related work.
+  - `lede-adm@lists.infradead.org <https://lists.infradead.org/mailman/listinfo/lede-adm>`_ - Use this list for project organisational purposes. Anyone can subscribe and read this list, only committers may write to this list.
+
+In addition there are two read-only announcement lists:
+
+  - `lede-bugs@lists.infradead.org <http://lists.infradead.org/mailman/listinfo/lede-bugs>`_ - This list receives bug tracking notifications from Flyspray.
+  - `lede-commits@lists.infradead.org <http://lists.infradead.org/mailman/listinfo/lede-commits>`_ - This list tracks the commits to our ''%%source.git%%'' and ''%%web.git%%'' repositories.
+
+===== IRC Channels =====
+
+The project provides 2 IRC channels on `freenode <https://webchat.freenode.net/>`_:
+
+  - #lede-dev - a public channel for everyone to join and participate.
+  - #lede-adm - a moderated channel that anyone can join but only people with +v flag can write on.
+
+===== Bug Tracker =====
+
+Please submit bug reports at https://bugs.lede-project.org/.
+
+===== Server Status Changes Announcements on Twitter =====
+
+We will post notices of server outages, maintenance, or other disruption on the `lede_project account on Twitter <https://twitter.com/lede_project>`_.
+
+===== Corporate Contact =====
+
+Please direct general inquiries to `lede-contact@lede-project.org <mailto:lede-contact@lede-project.org>`_ to open a confidential discussion with the :ref:`project developers <about:people>`.
+
+This contact address is primarily intended to find a suitable mode of cooperation and to inquire about project matters without having to disclose your corporate identity upfront. There will be no special treatment beyond this first contact. Please see the [[:rules|LEDE Project Rules]] for further information.
+
+Actual development should happen in public and corporations are strongly encouraged to send their contributions through the public mailing lists or in the form of Github pull requests.

contents.rst

@@ -1,23 +1,23 @@
-LEDE contents
-=============
+LEDE
+====
 
 This is a content list for all the resources. In the following list you can find information about the project.
 
 
 .. toctree::
    :maxdepth: 1
 
-   index
    reasons-to-use
-   documentation
+   about
+   contact
 
 LEDE Documentation
 ------------------
 
 LEDE is a highly extensible GNU/Linux distribution for embedded devices (typically wireless routers). LEDE is based on the OpenWrt project. Unlike many other distributions for routers, LEDE is built from the ground up to be a full-featured, easily modifiable operating system for embedded devices. In practice, this means that you can have all the features you need with none of the bloat, powered by a modern Linux kernel.
 
-:ref:`Quick Start Guide <quick-start>`
->>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+:doc:`Quick Start Guide <quick-start/index>`
+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 
 Start here if you are new to LEDE. Find out how to upgrade the firmware your home router to use LEDE and make your network at home much better.
 
@@ -26,19 +26,19 @@ Start here if you are new to LEDE. Find out how to upgrade the firmware your hom
 
    quick-start/index
 
-:ref:`User Guide <user-guide>`
+:doc:`User Guide <user-guide>`
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 
-Start here if you already have LEDE running on your router. LEDE has hundreds of optional packages that give you VPNs, VLANs, and other capabilities. :ref:`Read more... <user-guide>`
+Start here if you already have LEDE running on your router. LEDE has hundreds of optional packages that give you VPNs, VLANs, and other capabilities.
 
 
-:ref:`Developer Guide <guide-developer>`
+:doc:`Developer Guide <guide-developer>`
 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
 
-Start here if you want to create custom builds of LEDE or contribute to its development. There are a large number of tools that make the development easy. `Read more... <guide-developer:the-source-code>`_
+Start here if you want to create custom builds of LEDE or contribute to its development. There are a large number of tools that make the development easy.
 
 
 Where can I learn more?
 -----------------------
 
-The three guides above (Newcomer, User, and Developer Guides) have links to virtually all the information about LEDE contained in this documentation. However, you may find more support
+The three guides above (Newcomer, User, and Developer Guides) have links to virtually all the information about LEDE contained in this documentation. However, you may find more support in

index.rst

@@ -62,3 +62,9 @@ The \*Wrt community is made up of many great communities all tinkering on their
 +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | .. image:: /media/endorsements/openwisp.png   | `“We deeply appreciate the efforts of the LEDE project …” <http://openwisp.org/news/lede.html>`_                                                                                                    |
 +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+
+.. toctree::
+   :hidden:
+
+   contents

quick-start/sshadministration.rst

@@ -39,20 +39,22 @@ Cmder, Smartty, Putty, and WinSCP are terminal emulators that allow you to ssh i
 Using Cmder
 -----------
 **Cmder for Windows** is an open-source terminal emulator that runs on Windows. It is free to use and provides an easy "command line shell" that allows you to ssh into LEDE. Its attractive fonts and color scheme are easy on the eyes. The //Full// distribution is preferred (over the //mini// distribution), since it provides a bash emulation, with a Unix-y suite of commands.
-  - Download cmder from `http://cmder.net/`_
+  - Download cmder from http://cmder.net/
   - Unzip the `cmder.zip` file
-  - Open the Cmder folder, and double-click the {{:media:docs:howto:cmdericon.png?16|}} Cmder icon. You'll see a Cmder window open similar to the image below.
+  - Open the Cmder folder, and double-click the |cmdericon| Cmder icon. You'll see a Cmder window open similar to the image below.
   - To ssh into the LEDE router at 192.168.1.1, type ''ssh root@192.168.1.1'' then press Return
 
-.. image:: /media/
-   image
+.. |cmdericon| image:: images/cmdericon.png
+               :scale: 50%
+
+.. image:: images/cmder.png
 
 Using Smartty
 -------------
 
 Smartty gives you command line access to LEDE and allows you to open/edit/download/upload files in LEDE, and is overall more modern and user-friendly than Putty (another tool detailed below):
 
-  - Download Smartty from [[http://smartty.sysprogs.com/]]: choose "download" for the installer, or "portable version" if you want it as a standalone program that works without installation.
+  - Download Smartty from http://smartty.sysprogs.com/: choose "download" for the installer, or "portable version" if you want it as a standalone program that works without installation.
   - after installation or after unzipping the archive, doubleclick on **SmarTTY** executable file.
   - You will be greeted by a window with two choices, doubleclick on "setup a new SSH connection" (the other option is for serial connections, for usb-TTL dongles and somesuch you connect to the device's debug serial pins on the board, we won't use that now).
   - The window changes into the SSH setup, write the following info:
@@ -70,7 +72,7 @@ Using putty
 -----------
 
 Putty gives you command line access to LEDE:
-  - Download Putty from [[http://www.putty.org]]: Simply get the 32bit ''putty.exe'' download from the ''Alternative binary files'' section.
+  - Download Putty from http://www.putty.org: Simply get the 32bit ''putty.exe'' download from the ''Alternative binary files'' section.
   - Start ''putty.exe'' on your Windows client -> Putty's login window pops up.
   - go to the''Session'' category of Putty's login window, look for the field ''Host Name (or IP address)'' and simply enter the IP-address (e.g. **192.168.1.1**) of your LEDE device, keep the default provided port **22**.
   - Click the ''Open'' button at the Bottom to open a connection. This will pop up a shell windows, asking to ''login as''. Login as **root** with the LEDE password you have defined some time before. If you have not yet set a password yet on "root", you will not be asked for the password.
@@ -82,10 +84,12 @@ Using WinSCP
 
 WinSCP allows you to browse the LEDE file system in Windows Exlorer like GUI-style:
   - You have to install the SFTP server on the LEDE side first, as WinSCP needs that to connect successfully. On the putty command line (see previous section) execute:
+
     - ''opkg update''
     - ''opkg install openssh-sftp-server''
     - It usually is not required at this point, but for the sake of simplicity of this howto, reboot your LEDE device now, to make sure the SFTP service really starts up
-  - Download WinSCP from [[https://winscp.net/eng/download.php]], get the non-beta ''Installation package'' or ''portable executables'' and install or unzip them on your Windows client
+
+  - Download WinSCP from https://winscp.net/eng/download.php, get the non-beta ''Installation package'' or ''portable executables'' and install or unzip them on your Windows client
   - Start ''WinSCP.exe'' on your Windows client, WinSCP's login window will pop up
   - Click on ''New Site'' on the left, then enter your LEDE device IP address (192.168.1.1) on the right side into ''Host name'', keep the default port ''22''. In ''User name'' enter **root**, in ''Password'', enter your root **password** (or leave blank, if you have not set a password yet)
   - Click the ''Login'' at the bottom of the Window.
@@ -99,8 +103,9 @@ Linux Terminal Emulators
 
 All Linux distributions provide a command-line ssh client as part of the default installation.
 
-  - Open a terminal emulator and write ''ssh root@192.168.1.1'' ("ssh" is the command, "root" is the LEDE user you are connecting to, and "192.168.1.1" is LEDE default IP)
+  - Open a terminal emulator and write `ssh root@192.168.1.1` ("ssh" is the command, "root" is the LEDE user you are connecting to, and "192.168.1.1" is LEDE default IP)
   - there will be a message about accepting a new key from the LEDE device, write "yes" and press Enter key.
+
     - If for some reason you have reinstalled LEDE the device will have a different key and you get an error about key mismatch. The error will state what is the command line to copy-paste in your terminal to delete the old key and proceed.
   - if you want to close the session, write "exit"
 
@@ -113,6 +118,6 @@ macOS Terminal Emulators
 On macOS (formerly Mac OSX) any terminal emulator will allow you to ssh. There several terminal emulators:
 
   - Terminal - The macOS built-in terminal program. Find it in /Applications/Utilities
-  - iTerm2 [[https://iterm2.com/]] a much-enhanced terminal program. Donation-ware - it's worth it.
+  - iTerm2 https://iterm2.com/ a much-enhanced terminal program. Donation-ware - it's worth it.
 
 To ssh into your LEDE router at 192.168.1.1, type ''ssh root@192.168.1.1'', then press Return.

quick-start/starterfaq.rst

@@ -1,52 +1,68 @@
 LEDE Starter FAQ
 ================
 
-**Ok, so I've successfully flashed LEDE on my device. what should I do next?**\\
+**Ok, so I've successfully flashed LEDE on my device. what should I do next?**
+
 Set an initial root password, setup WiFi, get familiar with the troubleshooting/rescue options in the user guide, then browse the user guide for further config you may be interested in.
 
-**How do I access the web admin GUI on a default installation?**\\
+**How do I access the web admin GUI on a default installation?**
+
 Open http://192.168.1.1 or http://lede in your favorite web browser
 
-**What is the default admin username in LEDE?**\\
+**What is the default admin username in LEDE?**
+
 "root"
 
-**What is the initial password for root?**\\
+**What is the initial password for root?**
+
 There is no initial password set. Please set one manually, after your first login, either by using ''passwd'' on the command line or in `LUCI Menu System/Administration <http://lede/cgi-bin/luci/admin/system/admin>`_
 
-**Can I reset the 'root' password, in case I have forgotten it?**\\
+**Can I reset the 'root' password, in case I have forgotten it?**
+
 Yes, check the troubleshooting section of the user guide.
 
-**I seem to have messed up the LEDE device configuration, my LEDE device is no longer accessible. What do I do?**\\
+**I seem to have messed up the LEDE device configuration, my LEDE device is no longer accessible. What do I do?**
+
 Check the troubleshooting section of the user guide, several recovery options are available.
 
-**How can I enable SSL for the web admin gui?**\\
+**How can I enable SSL for the web admin gui?**
+
 In an SSH-command line, run ''opkg update'', then install the package ''opkg install luci-ssl'', then restart the router. Then you can access https://192.168.1.1 or https://lede with your favorite web browser
 
-**Is there a command line editor available in SSH?**\\
-use ''vi''. It's most important key shortcuts are:\\
-|ESC :q! | exits without saving|
-|ESC :wq | exit and save|
-|ESC i | insert text at the current cursor position|
-|ESC x | delete the character under the cursor|
-|ESC dd | delete the whole current line|
-|ESC o | open new line below cursor|
-|ESC O | open new line above cursor|
-
-**What other tools can I use for administration of LEDE from a windows client?**\\
+**Is there a command line editor available in SSH?**
+
+use `vi`. It's most important key shortcuts are:
+
+-------- -------------------------------------------
+ESC :q!  exits without saving
+ESC :wq  exit and save
+ESC i    insert text at the current cursor position
+ESC x    delete the character under the cursor
+ESC dd   delete the whole current line
+ESC o    open new line below cursor
+ESC O    open new line above cursor
+-------- -------------------------------------------
+
+**What other tools can I use for administration of LEDE from a windows client?**
+
 Get `Putty <http://www.putty.org>`_ for SSH access to LEDE and get `WinSCP <https://winscp.net>`_ as a file browser. For WinSCP to connect successful, you have to first ''opkg update'' then install the package ''opkg install openssh-sftp-server''. You can then use WinSCP to click through the LEDE file system and use its GUI editor for editing LEDE config files.
 
-**I would like to customize LEDE, but am having difficulties finding the packages that I am interested in.**\\
+**I would like to customize LEDE, but am having difficulties finding the packages that I am interested in.**
+
 Remember to first run ''opkg update'' once after each LEDE reboot, to refresh the list of available packages. LEDE will only temporary store the retrieved list in a temp RAM filesystem, losing the list of updates on every reboot.
 
-**Why is there a "WAN" and a "WAN6" and a "LAN" interface in LEDE, but no "LAN6" ?**\\
+**Why is there a "WAN" and a "WAN6" and a "LAN" interface in LEDE, but no "LAN6" ?**
+
 Note that there is a "WAN" and "WAN6" interface. Each of the 2 WAN interfaces holds config data related to the upstream interface (WAN is for IPv4 and has "DHCP client", while WAN6 is for IPv6 has "DHCPv6 client"). On the other hand "LAN" has both the config data for the downstream side for both IPv4 and IPv6 associated, so there is no need to have an extra LAN6 interface.
 Also note that both an interface and a zone called "LAN" exist. Also "WAN" is used both as a name for a zone and as a name for the IPv4 WAN interface. Both the "WAN" and "WAN6" interface belong to the "WAN" zone (so furthermore there is no "WAN6" zone)
 
-**Why is there both a "Save & Apply" and a "Save" button in LuCi?**\\
+**Why is there both a "Save & Apply" and a "Save" button in LuCi?**
+
 You can do several different changes in different tabs, each time clicking "Save" without committing the changes. You can then use "Save & Apply" to commit all of those changes in one transaction.
 
-**What is the difference of total available memory, free and buffered shown in LuCi status overview?**\\
-Total = free + buffered. \\
-Buffered = memory that is temporarily in use to handle I/O operations\\
-Free = really free memory\\
+**What is the difference of total available memory, free and buffered shown in LuCi status overview?**
+
+Total = free + buffered.
+Buffered = memory that is temporarily in use to handle I/O operations
+Free = really free memory
 

quick-start/sysupgrade-luci.rst

@@ -4,8 +4,8 @@ Sysupgrading an existing LEDE device from the web admin GUI
 Your device must already have an older LEDE or OpenWrt firmware installed, to be eligible for this "sysupgrade" procedure.
 
   * Alternatively refer to the :doc:`factory installation <factory-installation>` howto, to install LEDE on a device that still has vendor factory firmware on it.
-  * If your current LEDE installation does not have the web admin GUI installed or if you prefer to upgrade from the command line (upgrade from command line provides more fine-grained control), refer to :doc:`Upgrading LEDE from the Command Line </user-guide/sysupgrade.cli>`.
-  * If you have any questions about this description, ask for help on the `Installing and Using LEDE forum section <https://forum.lede-project.org/c/installation`_ before beginning.
+  * If your current LEDE installation does not have the web admin GUI installed or if you prefer to upgrade from the command line (upgrade from command line provides more fine-grained control), refer to :doc:`Upgrading LEDE from the Command Line </user-guide/sysupgrade-cli>`.
+  * If you have any questions about this description, ask for help on the `Installing and Using LEDE forum section <https://forum.lede-project.org/c/installation>`_ before beginning.
 
 Locate and download the LEDE firmware
 -------------------------------------
@@ -15,7 +15,7 @@ Locate and download the LEDE firmware
 
 Troubleshooting:
   * Some devices lack a sysupgrade image and require a special (and usually a bit more complex) installation procedure that is device-specific. This tutorial won't apply for such devices. Instead follow the custom installation description on the corresponding device page in the OpenWrt wiki.
-  * If you can't find your device, or if there is no "...sysupgrade.bin", you can consult the `"Installing and Using LEDE" Forum <https://forum.lede-project.org/c/installation`_ for help.
+  * If you can't find your device, or if there is no "...sysupgrade.bin", you can consult the `"Installing and Using LEDE" Forum <https://forum.lede-project.org/c/installation>`_ for help.
   * If you don't find your device in the Table of Hardware or Device Pages/Techdata pages, you can also try :doc:`alternative ways to find LEDE firmware images <alternate-directory-search>`
   * If you have accidently browsed the generic LEDE download folders to locate your device, you might see some more download files matching your device. Ignore those files: you only want the "...sysupgrade.bin" file .