From Fedora Project Wiki

(New page: {{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choo...)
 
m (Removing QA category)
 
(30 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section.  They are invisible when viewing this page.  To read it, choose the "edit" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR FEATURE.'''}}
<!-- All fields on this form are required to be accepted by FESCo.
<!-- All fields on this form are required to be accepted by FESCo.
  We also request that you maintain the same order of sections so that all of the feature pages are uniform.  -->
  We also request that you maintain the same order of sections so that all of the feature pages are uniform.  -->
Line 6: Line 4:
<!-- The actual name of your feature page should look something like: Features/YourFeatureName.  This keeps all features in the same namespace -->
<!-- The actual name of your feature page should look something like: Features/YourFeatureName.  This keeps all features in the same namespace -->


= Feature Name =
= Amber Client =
<!-- The name of your feature -->
<!-- The name of your feature -->


== Summary ==
== Summary ==
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
<!-- A sentence or two summarizing what this feature is and what it will do.  This information is used for the overall feature summary page for each release. -->
The Amber client is a feature that will allow users to search for, browse, comment on, and rate software applications available for Fedora and potentially other Linux distributions and repositories. In the long run, this application could be extended to allow users installing the application.


== Owner ==
== Owner ==
<!--This should link to your home wiki page so we know who you are-->
<!--This should link to your home wiki page so we know who you are-->
* Name: [[User:FASAcountName| Your Name]]
* Name: [[User:glaksmono| Grady Laksmono]]


<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
<!-- Include you email address that you can be reached should people want to contact you about helping with your feature, status is requested, or  technical issues need to be resolved-->
* email: <your email address so we can contact you, invite you to meetings, etc.>
* Email: <gradyfausta@laksmono.com>


== Current status ==
== Current status ==
* Targeted release: [[Releases/{{FedoraVersion||next}} | {{FedoraVersion|long|next}} ]]  
* Targeted release: [[Releases/{{12||next}} | {{12|long|next}}]]  
* Last updated: (DATE)
* Last updated: (DATE)
* Percentage of completion: XX%
* Percentage of completion: XX%
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->
<!-- CHANGE THE "FedoraVersion" TEMPLATES ABOVE TO PLAIN NUMBERS WHEN YOU COMPLETE YOUR PAGE. -->


== Detailed Description ==
== Detailed Description ==
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
The Amber project is a web application and client side program designed to allow users to search for, browse, comment on, and rate software applications available for Fedora and potentially other Linux distributions and repositories. In the long run, this application could be extended to allow users installing the application. In this case, we're specifically concern on the client program to be included as part of the feature for Fedora 12.
=== Web application ===
The web application is the main backbone of the application the Amber. As mentioned, the web application allows the user to search, browse, comment, and rate software application for Fedora and potentially other Linux distribution. The application is accessed through a web browser.
=== Client program ===
In addition of the functionality of the web application, the client program will allow the user to run the application in a single click from Fedora desktop or menu icon. Initially, the user will be presented with the username and password box requiring them to use the FAS or potentially OpenID, and remember their username and password such that they don't need to type them again, the user could also decide to run the application on the start-up. In addition, it may be not desirable to have a tab on the menu bar, instead, this client program will hide itself on the task-bar.


== Benefit to Fedora ==
== Benefit to Fedora ==
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new feature, what capabilities does it bring? Why will Fedora become a better distribution or project because of this feature?-->
The Amber project will benefit the Fedora users by informing them about a certain applications. When a user is new to Linux, especially Fedora, it is difficult for them to find a substitution for a proprietary software. When they use Google to find the application that may best suits them, Google will gives so many open source applications. The user may want to look through the application forum, other blog comments about the software, etc. This task is very tedious and could be wrap into one place, which is the idea behind the Amber project itself.


== Scope ==
== Scope ==
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
<!-- What work do the developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
* Client User Interface
* Client database communication
* Data sync with Fedora package database, comps.xml, and .desktop files
* TurboGears based web application
* Browse applications
* Search for applications
* Rate applications
* Comment on applications


== How To Test ==
== How To Test ==
Line 49: Line 65:
3. What are the expected results of those actions?
3. What are the expected results of those actions?
-->
-->
# Run Amber Client
# Search for an application to your needs by keywords
# Select one of the search result application
# Comment on the application
# Rate the application


== User Experience ==
== User Experience ==
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
<!-- If this feature is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
# Users should find it easier to find an application according to their needs
# Users should find it easier to find better recommended applications
# Users should find it easier to install applications to Fedora


== Dependencies ==
== Dependencies ==
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this feature depends?  In other words, completion of another feature owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel feature)? -->
=== Packages ===
* TurboGears
* PyGTK
* Python
=== Processes ===
* Getting amber approved by infrastructure to be run on fedora hosted servers


== Contingency Plan ==
== Contingency Plan ==
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "None necessary, revert to previous release behaviour."  Or it might not.  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Re-attempt for the next Fedora release
* Don't deploy, it won't affect any other processes


== Documentation ==
== Documentation ==
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
<!-- Is there upstream documentation on this feature, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
*
* [https://fedorahosted.org/amber/wiki/Definition Definition]
* [https://fedorahosted.org/amber/wiki Trac]
* [https://fedorahosted.org/amber/wiki/Scope Scope]


== Release Notes ==
== Release Notes ==
<!-- The Fedora Release Notes inform end-users about what is new in the release. Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The Fedora Release Notes inform end-users about what is new in the release. Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
*
 
The client program allows users with the FAS to search for applications, rate application, comment on applications. The program validates the users FAS in order to use the full functionality of the application.


== Comments and Discussion ==
== Comments and Discussion ==
* See [[Talk:Features/YourFeatureName]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
* See [[Talk:Features/Amber Client]]  <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->




Line 77: Line 115:
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
[[Category:Features needing QA approval]]
<!-- Note that the current Feature guidelines require useful Scope and Test Plans at certain milestones; QA is responsible for checking these, and will change this category as needed. -->

Latest revision as of 17:28, 17 April 2009


Amber Client

Summary

The Amber client is a feature that will allow users to search for, browse, comment on, and rate software applications available for Fedora and potentially other Linux distributions and repositories. In the long run, this application could be extended to allow users installing the application.

Owner

  • Email: <gradyfausta@laksmono.com>

Current status

Detailed Description

The Amber project is a web application and client side program designed to allow users to search for, browse, comment on, and rate software applications available for Fedora and potentially other Linux distributions and repositories. In the long run, this application could be extended to allow users installing the application. In this case, we're specifically concern on the client program to be included as part of the feature for Fedora 12.

Web application

The web application is the main backbone of the application the Amber. As mentioned, the web application allows the user to search, browse, comment, and rate software application for Fedora and potentially other Linux distribution. The application is accessed through a web browser.

Client program

In addition of the functionality of the web application, the client program will allow the user to run the application in a single click from Fedora desktop or menu icon. Initially, the user will be presented with the username and password box requiring them to use the FAS or potentially OpenID, and remember their username and password such that they don't need to type them again, the user could also decide to run the application on the start-up. In addition, it may be not desirable to have a tab on the menu bar, instead, this client program will hide itself on the task-bar.

Benefit to Fedora

The Amber project will benefit the Fedora users by informing them about a certain applications. When a user is new to Linux, especially Fedora, it is difficult for them to find a substitution for a proprietary software. When they use Google to find the application that may best suits them, Google will gives so many open source applications. The user may want to look through the application forum, other blog comments about the software, etc. This task is very tedious and could be wrap into one place, which is the idea behind the Amber project itself.

Scope

  • Client User Interface
  • Client database communication
  • Data sync with Fedora package database, comps.xml, and .desktop files
  • TurboGears based web application
  • Browse applications
  • Search for applications
  • Rate applications
  • Comment on applications

How To Test

  1. Run Amber Client
  2. Search for an application to your needs by keywords
  3. Select one of the search result application
  4. Comment on the application
  5. Rate the application

User Experience

  1. Users should find it easier to find an application according to their needs
  2. Users should find it easier to find better recommended applications
  3. Users should find it easier to install applications to Fedora

Dependencies

Packages

  • TurboGears
  • PyGTK
  • Python

Processes

  • Getting amber approved by infrastructure to be run on fedora hosted servers

Contingency Plan

  • Re-attempt for the next Fedora release
  • Don't deploy, it won't affect any other processes

Documentation

Release Notes

The client program allows users with the FAS to search for applications, rate application, comment on applications. The program validates the users FAS in order to use the full functionality of the application.

Comments and Discussion