From 2f982023129e55c1c7f693be41d575669cb626b7 Mon Sep 17 00:00:00 2001 From: Nick Daly Date: Thu, 26 Dec 2013 22:39:55 -0600 Subject: [PATCH] Added some module-level documentation. Of course, only stage 0 (#1: Hello!) is written. The rest will come next. --- modules/installed/first_boot.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/modules/installed/first_boot.py b/modules/installed/first_boot.py index 52b5f34a2..47315f9a7 100644 --- a/modules/installed/first_boot.py +++ b/modules/installed/first_boot.py @@ -10,6 +10,27 @@ import cfg import config from model import User +"""First Boot: Initial Plinth Configuration. + +See docs/design/first-connection.mdwn for details. + +The Plinth first-connection process has several stages: + +0. The user connects to Plinth for the first time and is redirected from + the home page to the Hello page. + +1. The user sets the Box's name, the administrator's name and + password, and the box's PGP key (optional). + +2. The box generates and the user receives any PGP keys. + +3. The box detects the network's configuration and restarts networking. + +4. The user interacts with the box normally. + +""" + + class FirstBoot(PagePlugin): def __init__(self, *args, **kwargs): PagePlugin.__init__(self, *args, **kwargs)