Feature #229

Τεκμηρίωση Υλοποίησης GUI

Added by Vangelis Koukis over 11 years ago. Updated over 9 years ago.

Status:Closed Start date:02/22/2011
Priority:Medium Due date:
Assignee:- % Done:

0%

Category:old_synnefo Spent time: -
Target version:v0.5.1

Description

Χρειάζεται να γραφτεί τεκμηρίωση για τη σχεδίαση κι υλοποίηση του GUI.

Πρέπει να φαίνεται με ποιον ακριβώς τρόπο το GUI [Javascript + HTML]
χειρίζεται αιτήσεις του χρήστη. Για κάθε δυνατή ενέργεια, πρεπει να
φαίνεται σε ποιες κλήσεις του API απεικονίζεται.

Εδώ ταιριάζει η περιγραφή του πώς χρησιμοποιείται η jQuery για να κατασκευαστούν
κλήσεις GET / PUT / POST για κάθε υποστηριζόμενη λειτουργία. Για κάθε
ενέργεια του χρήστη πρέπει να φαίνεται πώς μεταφράζεται σε κλήσεις του
Rackspace API και πώς ερμηνεύονται τα αποτελέσματά τους. Για ΚΑΘΕ
εξαιρετική κατάσταση πρέπει να περιγράφεται ο τρόπος χειρισμού της
[π.χ. αδυναμία επικοινωνίας με το Rackspace API endpoint, ή επιστροφή
κωδικού λάθους από αυτούς που περιγράφονται στην τεκμηρίωση του API].

History

#1 Updated by Vangelis Koukis over 11 years ago

  • Tracker changed from Bug to Feature

#2 Updated by Christos Psaltis about 11 years ago

έχουμε μεταφέρει την τεκμηρίωση από το wiki page που φτιάξαμε σε αυτό που υπήρχε ήδη. Μπορείτε να σβήσετε το http://trac.cslab.ece.ntua.gr:8081/cloud/wiki/GuiDoc

#3 Updated by Vangelis Koukis about 11 years ago

  • Target version set to v0.5

#4 Updated by Dimitris Moraitis almost 11 years ago

  • Status changed from Assigned to Feedback

Σε τηλεφωνική επικοινωνά που είχα χθες με τον κ. Κοζύρη μου διευκρίνησε ότι από πλευράς τεκμηρίωσης δεν χρειάζεται κάποιο ξεχωριστό developer manual αλλά περισσότερα σχόλια στον κώδικα που θα διευκολύνουν την κατανόηση του κώδικα και την περαιτέρω ανάπτυξη. Ισχύει αυτό ή περιμένετε και κάτι άλλο από εμάς;

#5 Updated by Vangelis Koukis almost 11 years ago

  • Status changed from Feedback to Assigned

Ο σχολιασμός των σημείων του κώδικα όπου γίνεται κάτι κρίσιμο και δύσκολο στην κατανόηση, είναι απαραίτητος, ώστε να μπορεί να συνεχιστεί η ανάπτυξή του.

Επιπλέον, χρειάζεται ενημέρωση της αντίστοιχης σελίδας στο trac, ώστε να φαίνονται οι βασικοί μηχανισμοί που χρησιμοποιεί ο κώδικας για τη λειτουργία του. Αυτό δεν είναι πάνω από 3 σελίδες ουσιαστικού κειμένου.

Ενδεικτικά παραδείγματα:
  1. με ποιον τρόπο χρησιμοποιούνται οι timers για να κάνει το UI περιοδικές κλήσεις GET με ?changes-since
  2. με ποιον τρόπο παράγονται δυναμικοί κόμβοι στο DOM με βάση το αποτέλεσμα του GET /servers

#6 Updated by Vangelis Koukis almost 11 years ago

  • Target version changed from v0.5 to v0.5.1

#7 Updated by Vangelis Koukis almost 11 years ago

  • Status changed from Assigned to Closed
  • Assignee deleted (Christos Psaltis)

Ο Χρίστος έστειλε κείμενο με documentation, θα μπει στο αντίστοιχο Wiki, το ticket κλείνει.

#8 Updated by Vangelis Koukis over 9 years ago

  • Category set to old_synnefo

Also available in: Atom PDF