Features/FirstAidKit

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(move to new category naming)
(added 'FIXMEs' at the request of the feature owner)
Line 1: Line 1:
 
= First Aid Kit =
 
= First Aid Kit =
 
 
  
 
== Summary ==
 
== Summary ==
  
Anaconda's rescue mode is useful for getting a rootfs mounted and then dropping you to a shell, but for less experienced users, a more streamlined experience with choices of things to do would help in rescuing their system.  You can checkout the wiki and other cool stuff at https://fedorahosted.org/firstaidkit/
+
Anaconda's rescue mode is useful for getting a rootfs mounted and then dropping you to a shell.  A streamlined experience with with a list of choices would be more helpful for new users to rescue their system.   
  
 
== Owner ==
 
== Owner ==
* Name: MartinSivak / JoelGranados
+
* Name: MartinSivak / JoelGranados '''FIXME''': please link names to wiki home page
  
 
== Current status ==
 
== Current status ==
* Targeted release: N/A
+
* Targeted release: Fedora 10
 
* Last updated: 2008-07-20 (version 1.2.1 is in rawhide)
 
* Last updated: 2008-07-20 (version 1.2.1 is in rawhide)
 
* Percentage of completion: ''' 95% '''.  The only thing that keeps me from putting 100% is the fact that we keep doing small changes to the backend.  Additionally lots of plugins are still to come, but most, if not all, the backend work is done.
 
* Percentage of completion: ''' 95% '''.  The only thing that keeps me from putting 100% is the fact that we keep doing small changes to the backend.  Additionally lots of plugins are still to come, but most, if not all, the backend work is done.
Line 24: Line 22:
  
 
Implementing these as individual pieces rather than entirely tying them to anaconda would be the most beneficial way to do it.  Then we can tie them together with a relatively simple "Fix my System" menu and also make use of them from a graphical version of the same on the LiveCD.
 
Implementing these as individual pieces rather than entirely tying them to anaconda would be the most beneficial way to do it.  Then we can tie them together with a relatively simple "Fix my System" menu and also make use of them from a graphical version of the same on the LiveCD.
 +
 +
See the upstream project at https://fedorahosted.org/firstaidkit/
  
 
== Benefit to Fedora ==
 
== Benefit to Fedora ==
Line 31: Line 31:
 
== Scope ==
 
== Scope ==
  
FirstAidKit is planned as a package.  It will be a pluggable application that can house all kinds of plugins.  Each plugin will be one automated recovery task.
+
* FirstAidKit is planned as a package.  It will be a pluggable application that can house all kinds of plugins.  Each plugin will be one automated recovery task.
  
 
== Test Plan ==
 
== Test Plan ==
Line 37: Line 37:
 
Testing
 
Testing
 
* test features from old "rescue" mode to see that they still work or have equivalent functionality
 
* test features from old "rescue" mode to see that they still work or have equivalent functionality
 +
 +
'''FIXME'''--much more detail needed here, preferably steps that someone unfamiliar with the package can follow to complete testing.
  
 
== User Experience ==
 
== User Experience ==
Line 47: Line 49:
  
 
== Contingency Plan ==
 
== Contingency Plan ==
 +
 +
'''FIXME'''--imost likely you can explain that this is not applicable because it is a new feature that is not depended on by other applications.
  
 
== Documentation ==
 
== Documentation ==
Line 53: Line 57:
  
 
== Release Notes ==
 
== Release Notes ==
 +
 +
'''FIXME'''--include rough draft of how the release note should read.  Reusing some of the wording from the summary and description would work well.
  
 
----
 
----
  
 
[[Category:FeaturePageIncomplete]]
 
[[Category:FeaturePageIncomplete]]

Revision as of 18:30, 6 August 2008

Contents

First Aid Kit

Summary

Anaconda's rescue mode is useful for getting a rootfs mounted and then dropping you to a shell. A streamlined experience with with a list of choices would be more helpful for new users to rescue their system.

Owner

  • Name: MartinSivak / JoelGranados FIXME: please link names to wiki home page

Current status

  • Targeted release: Fedora 10
  • Last updated: 2008-07-20 (version 1.2.1 is in rawhide)
  • Percentage of completion: 95% . The only thing that keeps me from putting 100% is the fact that we keep doing small changes to the backend. Additionally lots of plugins are still to come, but most, if not all, the backend work is done.

Detailed Description

For a long time, people have asked for a task based approach to rescuing their systems. Rescue mode is an okay start, but we can do a lot better by automating simple and common recovery tasks. Obvious things would be

  • dmraid rebuild and recovery
  • reinstall bootloader
  • recreate the initrd
  • reinstall some "base" packages

Implementing these as individual pieces rather than entirely tying them to anaconda would be the most beneficial way to do it. Then we can tie them together with a relatively simple "Fix my System" menu and also make use of them from a graphical version of the same on the LiveCD.

See the upstream project at https://fedorahosted.org/firstaidkit/

Benefit to Fedora

Makes it easier for users to rescue their systems in case of problems

Scope

  • FirstAidKit is planned as a package. It will be a pluggable application that can house all kinds of plugins. Each plugin will be one automated recovery task.

Test Plan

Testing

  • test features from old "rescue" mode to see that they still work or have equivalent functionality

FIXME--much more detail needed here, preferably steps that someone unfamiliar with the package can follow to complete testing.

User Experience

In case of any mishaps with the user's system. He/she should be able to run the rescue environment or livecd and use the FirstAidKit environment. Either by running an automated "Fix whatever is wrong with my system" process, or specific tasks from specific plugins for the more advanced user.

Dependencies

None for now.

Contingency Plan

FIXME--imost likely you can explain that this is not applicable because it is a new feature that is not depended on by other applications.

Documentation

Pydoc generated from the code to ease the plugin developer experience and user documentation.

Release Notes

FIXME--include rough draft of how the release note should read. Reusing some of the wording from the summary and description would work well.