Feature pages are design documents that developers have created while collaborating on oVirt.

Most of them areoutdated, but provide historical design context.

They arenotuser documentation and should not be treated as such.

Documentation is available here.

Feature template

Your Feature’s Name

Give your feature a name. This name will also be the title of your feature page. It should be short and meaningful, and as much as possible, describe what the feature is about.

Summary

Summarize what this feature is and what it will do. Explain the problem it aims to solve, and the benefits to the end user. This information is used for the overall feature summary page for each release.

Owner

This should link to your GitHub profile so we know who you are.

  • Name: My User (MyUser)

Include your email address to enable people to contact you: to help with the feature, to get a status update, or to raise technical issues that need addressing.

Detailed Description

Expand on the summary by clearly explaining the feature’s purpose.

Prerequisites

List any hardware or software prerequisites or any steps that need to be performed before the feature can be implemented.

Limitations

List the feature’s limitations.

Benefit to oVirt

Explain the benefit to oVirt. If this is a major capability update, specify the changes made. If this is a new feature, list the capabilities it adds and explain. Focus on the overall benefit to the project.

Entity Description

List new entities and changes in existing entities.

CRUD

Describe the create/read/update/delete operations on the entities, and what each operation should perform.

User Experience

Describe any user experience related issues. For example: “We need a wizard for ….”, “the behavior is different in the UI because …..”, etc. Add GUI mockups to make your explanation clearer.

Installation/Upgrade

Describe how the feature will affect new or existing installations.

User work-flows

Describe the high-level work-flows relevant to this feature.

Event Reporting

Provide guidance about the process of reporting events related to this feature.

Answer the following questions:

  1. What other packages depend on this feature?
  2. Are there any issues beyond the developers’ control on which the completion of this feature depends? (e.g. the completion of another feature with a different owner).
  3. Will other features be affected by the implementation of this feature?

Documentation & External references

Does this feature have upstream documentation, notes, or RFEs written by you? Add links to those resources, to enable interested developers to get involved.

Testing

Explain how this feature may be tested by a user or a quality engineer. List relevant usage scenarios and expected results.

Contingency Plan

Explain what will be done in the event that the feature is not ready in time.

Release Notes

  == Your feature heading ==
  A descriptive text of your feature to be included in release notes