Changeset 10721 for main/eko-disco-specs

Timestamp:

8 Nov 2013, 08:30:30 (11 years ago)

Author:

Henrik Bettermann

Message:

Let's call it the Eko Disco Portal Project (working title).

Let's use the 'About This Document' page for a more detailed introduction into the project. Assistance from Nigeria needed!!

Location:

main/eko-disco-specs/trunk

Files:

• conf.py (modified) (5 diffs)
• index.rst (modified) (2 diffs)
• intro.rst (modified) (2 diffs)
• use-cases.rst (modified) (1 diff)

main/eko-disco-specs/trunk/conf.py

@@ -45 +45 @@
 
 # General information about the project.
-project = u'Eko-Disco Specification'
+project = u'Eko Disco Portal Specification'
 copyright = u'2013, WAeUP Germany'
 
@@ -191 +191 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'ekodisco-specs.tex', u'Eko-Disco Specifications',
+  ('index', 'ekodisco-specs.tex', u'Eko Disco Portal Specifications',
    u'WAeUP Germany', 'manual'),
 ]
@@ -223 +223 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'ekodisco-specs', u'eko-disco specs Documentation',
+    ('index', 'ekodisco-specs', u'Eko Disco Portal Specifications',
      [u'WAeUP Germany'], 1)
 ]
@@ -237 +237 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'ekodisco-specs', u'eko-disco specs Documentation',
+  ('index', 'ekodisco-specs', u'Eko Disco Portal Specifications',
    u'WAeUP Germany', 'ekodisco-specs', 'One line description of project.',
    'Miscellaneous'),
@@ -258 +258 @@
 
 # Bibliographic Dublin Core info.
-epub_title = u'Eko-Disco Specifications'
+epub_title = u'Eko Disco Portal Specifications'
 epub_author = u'WAeUP Germany'
 epub_publisher = u'WAeUP Germany'

main/eko-disco-specs/trunk/index.rst

@@ -1 @@
-.. eco-disco specs documentation master file, created by
+.. eco disco specs documentation master file, created by
    sphinx-quickstart on Wed Sep  4 09:10:02 2013.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Eko-Disco Specifications
-========================
+Portal Specifications
+=====================
 
 .. Contents:
@@ -19 +19 @@
 
 
-Indices and tables
+Indices and Tables
 ==================
 

main/eko-disco-specs/trunk/intro.rst

@@ -1 @@
-About This Document
-*******************
+Introduction
+************
 
-These are the project specifications for the Eko-Disco project.
-
+These are the project specifications (specs) for the Eko Disco Portal (EDP).
 They describe in a more formal manner the requirements, preconditions,
-postconditions, etc. needed to build the portal software for the
-Eko-Disco project.
-
+postconditions, etc. needed to build the software for the EDP.
 Their main goal is to express the expectations of all involved parties
 regarding the mentioned project.
@@ -14 +11 @@
 requirements.
 
-Download a pdf version `here <ekodisco-specs.pdf>`_.
+Download a pdf version of the specs `here <ekodisco-specs.pdf>`_.
+
+Background
+----------
+
+In February 2013 the Nigerian Eko Electricity Distribution Company (Eko Disco)
+was privatised and sold to West Power & Gas Limited (WPGL). Eko Disco is one
+of 11 distribution companies in Nigeria.
+
+...
+
+Expectations
+------------
+
+...
+
+Eko Disco Portal (EDP)
+----------------------
+
+...

main/eko-disco-specs/trunk/use-cases.rst

@@ -5 +5 @@
 
 Here we collect all use-cases identified to occur with regard to the
-Eko-Disco project. Use-cases are important to check which
+Eko Disco Portal. Use-cases are important to check which
 :ref:`label-actors` interact with the system in what way.