Changes between Version 5 and Version 6 of Documentation


Ignore:
Timestamp:
Mar 27, 2010, 2:29:37 PM (10 years ago)
Author:
bruno
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation

    v5 v6  
    22
    33This page is targetted at providing a more living documentation for !MondoRescue vs the current [http://www.mondorescue.org/docs/mondorescue-howto.html HOWTO].
     4
     5THe current idea is this one:
     6{{{
     7I think it's time for a documentation revamp phase.
     8My goals are in order:
     9
     101/ Unify the 2 existing FAQs on the wiki
     11   Advantage: Single point of info
     12   Drawback: Breaks existing references.
     132/ Keep an official doc under docbook to generate multiple formats (HTML, PDF, RTF, Text, ...)
     14   Advantage: Easier access whatever context. Put under SVN for each
     15   version for historicl purposes
     16   Drawback: Need to write/use a trac2docbook tool. Increase check phase
     17   before release.
     183/ Put the whole doc on the wiki and merge with some existing pages
     19   Advantage: easy modifications.
     20   Drawback: Control of the content
     214/ Allow for bi-directional modifications (docbook *and* wiki)
     22   Advantage: easy modifications with vim on my side in docbook
     23   (copy/paste, search replace, ...)
     24   Drawback: Need to write/use a docbook2trac tool. Increase check phase
     25Now some questions:
     26
     27- Does that sound like a good idea ?
     28- Who would like to volunteer to help ? (especially neither Victor nor
     29  myself are native english speakers so fixes are always welcome here).
     30Note that if there is no volunteer, I'm must less inclined to to more
     31than the FAQ, as it represents quite some work, and the current status is
     32for me working well (except for some content but that could be fixed
     33independently)
     34
     35The TOC I'd like to propose for the Doc is the following based on the
     36existing HOWTO:
     37(Each main chapter could be a dedicated Wiki page)
     38
     391. About this Guide
     40    1.1. Purpose / Scope of this Guide
     41    1.2. New versions of this document
     42    1.3. Suggestions / Feedback
     43    1.4. Aknowledgements
     44(Updated but not touched that much)
     45
     462. QuickStart
     47(Updated but not touched that much)
     48
     493. Overview
     50(Updated but not touched that much)
     51    3.1. MondoRescue
     52    3.2. Mindi
     53    3.3. Linux Backup
     54    3.4. Windows Backup
     55        3.4.1. Windows ME/95/98
     56        3.4.2. Windows NT4/2K/XP
     57    3.5. Mondo Rescue and Mindi Linux History
     58    3.6. System Requirements
     59        3.6.1. Hardware Requirements
     60        3.6.2. Kernel Requirements
     61        3.6.3. Software Requirements
     62
     634. Installation
     64(This should be rewritten, IMO completely using what already exists on
     65the Web site and the wiki)
     66    4.1 SVN based installations
     67    4.2 tar.gz based installations
     68    4.3 Packages based installations
     69        4.3.1 Deb based installations
     70        4.3.2 RPM based installations
     71        4.3.3 ebuild based installations
     72        4.3.3 other packages based installations
     73    4.4 Upstream vs distribution packages
     74        4.4.1 Deb based installations
     75        4.4.2 RPM based installations
     76        4.4.3 ebuild based installations
     77        4.4.3 other packages based installations
     78
     795. Tests
     80(This one should be increased with a mondoarchive section and also a
     81debugging part from the Wiki)
     82    5.1. Testing mindi
     83    5.2. Testing mondoarchive
     84    5.3. Testing mondorestore
     85    5.4. Debugging MondoRescue issues
     86
     876. mindi: mini-distribution builder
     88    6.1. Recommendations
     89    6.2. Command and Options
     90    6.3. Distributions specificities
     91
     927. Backup
     93(Updated but not touched that much)
     94    7.1. Recommendations
     95    7.2. Backup Commands and Options
     96        7.2.1. Standard Example With CD-R
     97        7.2.2. Standard Example With CD-RW
     98        7.2.3. Standard Example With Tape
     99        7.2.4. Standard Example With Failsafe kernel
     100        (This will be removed in 2.2.10)
     101        7.2.5. Standard Example With Network Backup
     102    7.3. Distributions specificities
     103
     1047bis. HOWTO run mondo interactively using cron
     105(Shouldn't that be rather a section of the previous chapter ?)
     106(Could someone check whther this is still valid and a problem)
     107    7.1. Overview
     108    7.2. Introduction
     109    7.3. Who should read this?
     110        7.3.1. Insurance
     111        7.3.2. Efficiency
     112    7.4. The Problem
     113        7.4.1. Cron's environment
     114        7.4.2. Interactivity
     115        7.4.3. Screen
     116    7.5. The Solution
     117        7.5.1. Briefly
     118        7.5.2. In Detail
     119
     1208. Compare
     121(Updated but not touched that much)
     122
     1239. Restore
     124(Updated but not touched that much)
     125    9.1. Overview
     126    9.2. Tips and Tricks
     127        9.2.1. Barebones (Nuke) Restore
     128        9.2.2. Interactive Restore
     129        9.2.3. Expert Restore
     130        9.2.4. Modified partitions - Restore to a different disk geometry
     131        9.2.5. Advanced
     132    9.3. Distributions specificities
     133
     13410. FAQ
     135(First to be touched and re-formated)
     136    10.1. Overview and Support
     137    10.2. General Questions
     138    10.4. Installation related Questions
     139        10.4.1. Debian related questions
     140        10.4.2. Ubuntu related questions
     141        10.4.3. Fedora related questions
     142        10.4.4. OpenSuSE related questions
     143        10.4.5. Mandriva related questions
     144        ....
     145    10.5. Environment related Questions
     146       10.5.1. Hardware
     147           10.5.1.1 CD/DVD/...
     148           10.5.1.2 Tapes
     149           10.5.1.3 USBKeys/disks/...
     150           10.5.1.4 Raid
     151       10.5.2. Software
     152           10.5.2.1 Kernel
     153           10.5.2.2 Boot Loader
     154           10.5.2.3 Raid
     155           10.5.2.4 LVM
     156           10.5.2.5 FileSystems
     157           10.5.2.6 Virtualization
     158    10.6. mindi related Questions
     159    10.7. mondoarchive related Questions
     160    10.8. mondorestore related Questions
     161        10.8.1. Booting issues
     162        10.8.2. Kernel/Modules issues
     163
     164What are your feedbacks on this ?
     165}}}
    4166
    5167= Backup =