The wikis are now using the new authentication system.
If you did not migrate your account yet, visit https://idp-portal-info.suse.com/

openSUSE:Documentation Contribute

Μετάβαση σε: πλοήγηση, αναζήτηση
Συνεισφορά στα εγχειρίδια του openSUSE.

Πώς να συνεισφέρετε

Στην παρούσα κατάσταση η τεκμηρίωση του openSUSE συντηρείται κυρίως στη Novell από την Ομάδα Τεκμηρίωσης του SUSE. Η συζήτηση στη λίστα opensuse-marketing έχει δείξει ότι ο κόσμος ενδιαφέρεται να συνεισφέρει στην τεκμηρίωση του openSUSE—ένα γεγονός το οποίο καλωσορίζουμε!


Τα εγχειρίδιά μας είναι γραμμένα σύμφωνα με το πρότυπο NovDoc XML, ένα απλουστευμένο υποσύνολο του DocBook (http://www.docbook.org/). Τα πηγαία αρχεία XML για τα εγχειρίδια φιλοξενούνται σε έναν SVN server. Η δημιουργία βιβλίων από τα πηγαία αρχεία XML γίνεται μέσω του περιβάλλοντος ανάπτυξης susedoc build environment, το οποίο αναπτύσσεται και συντηρείται επίσης από την ομάδα τεκμηρίωσης. Αυτό το περιβάλλον ανάπτυξης περιλαμβάνει όλα τα απαραίτητα για τη δημιουργία βιβλίων από το DocBook ή το NovDoc και παρέχεται μαζί με τη διανομή openSUSE (ονομασία πακέτου: susedoc, άδεια χρήσης: GPL). Επίσης μπορεί να επιθυμείτε να μας υποδείξετε παραλείψεις, διορθώσεις, ή ακόμη να ετοιμάσετε άρθρα (Wiki, txt, PDF, οτιδήποτε) τα οποία μπορούν να συγχωνευτούν ή να αναφερθούν.

Θα μας επιτρέψετε να μη λάβουμε μέρος στη διαμάχη σχετικά με το ποια εργαλεία είναι σωστά ή λάθος. Μας αρέσει πραγματικά η αρχική ιδέα της δημιουργίας ενός βιβλίου για το openSUSE από την κοινότητα. Επιπλέον, ψάχνουμε ήδη τρόπους για να συνδέσουμε το Wiki ή/ και το OpenOffice με το DocBook. Οι ιδέες είναι ευπρόσδεκτες!

Ένας φόρος τιμής στους χρήστες μας που χρησιμοποιούν EMACS


Διατηρώντας επικοινωνία με την Ομάδα Τεκμηρίωσης του SUSE

Το να έρθετε σε επαφή μαζί μας είναι πολύ εύκολο—είτε εγγραφείτε στη λίστα ταχυδρομείου opensuse-doc mailinglist είτε συνδεθείτε στο IRC κανάλι #opensuse-doc στο freenode. Αν έχετε ερωτήσεις, προτάσεις ή απλά θέλετε να πείτε ένα γεια, τότε αυτά είναι τα μέρη για να το κάνετε.

Μπορείτε να γνωρίσετε από κοντά τα μέλη της ομάδας τεκμηρίωσης στο συνέδριο για το openSUSE στη Νυρεμβέργη ή στη FOSDEM στις Βρυξέλλες. Στο συνέδριο για το openSUSE του 2010 υπήρξε μια συζήτηση σχετικά με ένα από τα τελευταία μας έργα, το openSUSE Book Builder (δείτε #openSUSE_BookBuilder παρακάτω ή ανατρέχτε στη διεύθυνση http://conference.opensuse.org/indico//contributionDisplay.py?contribId=71&confId=0).

Διαδικασία αναφοράς σφαλμάτων τεκμηρίωσης ή πρότασης ρυθμίσεων

Στην παρούσα κατάσταση είναι διαθέσιμα δύο κανάλια ανατροφοδότησης για μας, σε περίπτωση που θέλετε να παραθέσετε διορθώσεις ή βελτιώσεις:

  • Δημιουργείστε μια αναφορά σφάλματος (bug report) ή ένα αίτημα βελτίωσης για ένα στοιχείο της τεκμηρίωσης για το σχετικό προϊόν.

Ή, πολύ ευκολότερα:

  • Χρησιμοποιήστε το σύστημα σχολιασμού doc:
    Πηγαίντε στη διεύθυνση http://www.novell.com/documentation/opensuse113/ όπου φιλοξενείται η τεκμηρίωση του openSUSE 11.3. Κάντε κλικ σε έναν τίτλο του εγχειριδίου και πλοηγηθείτε στη σελίδα που έχετε εντοπίσει ένα λάθος/ θέλετε να προτείνετε βελτιώσεις. Μετακυλήστε τη σελίδα μέχρι στο τέλος αυτής και κάντε κλικ στην επιλογή "Προσθήκη σχολίου". Προσθέστε το σχόλιό σας. Αν ενδιαφέρεστε να λάβετε απάντηση θα πρέπει να παρέχετε το όνομά σας και τη διεύθυνση ηλεκτρονικού ταχυδρομείου (email).

Το σχόλιό σας θα δρομολογηθεί απευθείας στην ομάδα μας, έτσι ώστε να μπορέσουμε να το αντιμετωπίσουμε.

Μετάφραση Εγχειριδίων

Εάν ενδιαφέρεστε να μεταφράσετε τα εγχειρίδιά μας, μπορούμε να σας παρέχουμε την απαραίτητη υποδομή. Την παρούσα χρονική στιγμή η Ρωσική Ομάδα Μετάφρασης Currently χρησιμοποιεί ήδη το SVN αποθετήριό μας στο berliOS για τη μετάφραση των εγχειριδίων του openSUSE 11.3.

Συνεισφέροντας νέα κεφάλαια ή βιβλία

Αν θέλετε να συνεισφέρετε μεγαλύτερο όγκο περιεχομένου (κεφάλαια, παράγραφοι, κ.λπ.), παρακαλώ ελάτε σε επαφή μαζί μας (δείτε παραπάνω), και πείτε μας πού και τι επιθυμείτε να συνεισφέρετε. Μην ανησυχείτε, ΔΕΝ απαιτείται να γνωρίζετε XML, susedoc, ή άλλα παρόμοια εργαλεία—αυτό είναι κάτι που μπορούμε να το αναλάβουμε εμείς;-).

Σε περίπτωση που είστε περίεργοι σχετικά με τη συγγραφή σε XML, ρίχτε μια ματιά σε αυτό το βίντεο flow3.typo3.org. Παρόλο που σχετίζεται με το Typo3, είναι παρόλα αυτά πολύ χρήσιμο, καθώς δείχνει πώς μπορεί κάποιος να δουλέψει με την XML χωρίς πολύ κόπο.

Συνεισφέροντας στο περιβάλλον ανάπτυξης susedoc

Το susedoc φιλοξενείται δημόσια στο https://developer.berlios.de/projects/opensuse-doc/ (φάκελος /trunk/tools/docmaker) και μπορεί να ερευνηθεί ανώνυμα. Τα patches είναι ευπρόσδεκτα! Εάν ενδιαφέρεστε να συνεισφέρετε περισσότερο από ένα περιστασιακό patch, μπορείτε να αποκτήσετε πλήρη πρόσβαση στο έργο.

Επισκόπηση: Τι βρίσκετε υπό διεκπεραίωση

Η τεκμηρίωση του SUSE έχει μερικά ακόμη έργα υπό διεκπεραίωση. Πρώτον και κύριον εργαζόμαστε έτσι ώστε να σας διευκολύνουμε στο να συνεισφέρετε. Δεύτερον, έχουμε σχεδιάσει δύο βασικά έργα λογισμικού.

Έκδοση των αρχείων με τον πηγαίο κώδικα των βιβλίων

Τα αρχεία με τον πηγαίο κώδικα XML για τα εγχειρίδιά μας φιλοξενούνται σε έναν εσωτερικό SVN server της Novell. Την περίοδο αυτή βρισκόμαστε στη διαδικασία μεταφοράς τους σε δημόσιο SVN στο BerliOS, όπου θα είναι διαθέσιμα για ανώνυμη έρευνα. Οι συντηρητές κειμένων θα αποκτήσουν δικαιώματα εγγραφής. Ως ένα πρώτο βήμα, η τεκμηρίωση του SUSE Studio και ο οδηγός προτύπων τεκμηρίωσης του openSUSE φιλοξενούνται στη διεύθυνση https://developer.berlios.de/projects/opensuse-doc/ Περισσότερα σε σύντομο χρονικό διάστημα.

Μπορούμε επίσης να παρέχουμε υποδομή για μεταφράσεις εγχειριδίων σε αυτόν τον server—μάλιστα οι Ρώσοι μεταφραστές ήδη τον χρησιμοποιούν.

Επαναγράφοντας τον κώδικα του Περιβάλλοντος Ανάπτυξης

Το περιβάλλον ανάπτυξης που χρησιμοποιούμε (susedoc) αποτελείται από μία συλλογή εργαλείων κάνοντας χρήση των make, Bash, Python, και Perl. Παρόλο που αυτή η συλλογή εργαλείων δουλεύει πολύ καλά, θέλουμε να την ενοποιήσουμε ώστε να κάνουμε ευκολότερες τις μελλοντικές βελτιώσεις. Έχουμε ξεκινήσει τη συγγραφή κώδικα για μια κεντρική βιβλιοθήκη docmaker σε Perl και Python, η οποία πρέπει να παρέχει όλα τα απαραίτητα για τη διαχείριση, παρακολούθηση και δημιουργία βιβλίων από αρχεία με πηγαίο κώδικα XML. Η ανάπτυξη της βιβλιοθήκης αυτής βρίσκεται σε πολύ πρώιμο στάδιο—εάν ενδιαφέρεστε να μας βοηθήσετε ελάτε σε επαφή μαζί μας. Τα αρχεία με τον πηγαίο κώδικα είναι διαθέσιμα στη διεύθυνση http://svn.berlios.de/svnroot/repos/opensuse-doc/trunk/tools/docmaker/

openSUSE BookBuilder

Συνοπτικά, το openSUSE BookBuilder είναι μια βιβλιοθήκη που χρησιμοποιεί το susedoc για την αυτόματη δημιουργία βιβλίων από αρχεία με πηγαίο κώδικα XML. Προστέθηκε μια διαδικτυακή εφαρμογή που εξυπηρετεί ως εικονική βιβλιοθήκη. Δείτε τη διεύθυνση http://conference.opensuse.org/indico/contributionDisplay.py?contribId=71&confId=0 για μια περισσότερο λεπτομερής περιγραφή. Εάν ενδιαφέρεστε για το έργο αυτό, ελάτε στη σχετική συζήτηση στο συνέδριο για το openSUSE ή επικοινωνήστε μαζί μου απευθείας.

Δομή SVN

Η δομή του BerliOS SVN server είναι περίπου ως εξής:

  • trunk/documents
    Κάθε υποκατάλογος περιλαμβάνει ένα προϊόν. Υπάρχει η δυνατότητα να ρίξετε μια ματιά μόνο σε εκείνους τους υποκαταλόγους που σας ενδιαφέρουν. Έτσι δε χρειάζεται να δείτε τα πάντα. :)
    • trunk/documents/distribution/
      Περιλαμβάνει την πλήρη διανομή openSUSE, συμπεριλαμβανομένων των SLES και SLED. Αυτός ο υποκατάλογος είναι και ο μεγαλύτερος. Ο λόγος για αυτό έγκειται στο γεγονός ότι διαμοιράζουμε πολύ κείμενο μεταξύ openSUSE και SLE{S,D}. Συνήθως περιλαμβάνει και τα αρχεία για τις διάφορες γλώσσες.
    • trunk/documents/distribution/ha
      Απευθύνεται σε διαχειριστές που θα ήθελαν να μάθουν κάτι σχετικά με τον υψηλής διαθεσιμότητας κόσμο μας
    • trunk/documents/distribution/lfl
      Περιλαμβάνει τα προηγούμενά μας μαθήματα πάνω στο έργο Lizards
    • trunk/documents/distribution/slepos
      Περιλαμβάνει τον οδηγό SLEPOS και ένα εγχειρίδιο διαμόρφωσης για την υπηρεσία Point of Service του SUSE Linux Enterprise
    • trunk/documents/distribution/smt
      Παρέχει μια γενική επισκόπηση του SUSE Lifecycle Management Server
    • trunk/documents/distribution/studio
      Περιλαμβάνει έναν οδηγό για γρήγορη εκκίνηση, έναν οδηγό χρήστη και έναν οδηγό διαχειριστή για το SUSE Studio Onsite
    • trunk/documents/distribution/styleguide
      Όπως μερικά coding styles για τους προγραμματιστές, έτσι κι εμείς έχουμε ορισμένες κατευθύνσεις για το πώς δημιουργούμε τα έγγραφά μας. We use the styleguide to clarify how to make our docs consistent and hopefully easy to read.
    • trunk/documents/distribution/webyast
      Ο διαχειριστής πακέτων YaST μέσω Web
  • trunk/releasenotes
    Θα αποτελέσει το μέρος για τα release notes. Προς το παρόν είναι κενό.
  • trunk/tools
    Περιλαμβάνει ορισμένα σημαντικά εργαλεία τεκμηρίωσης:
    • trunk/tools/docmaker
      Ο μηχανισμός μας δημιουργίας εγγράφων, ο οποίος μπορεί να δημιουργήσει αρχεία PDF, HTML, EPUB, ή κειμένου. Ίσως θα έπρεπε να το ονομάσουμε susedoc ως πακέτο RPM. :)
    • trunk/tools/obb
      Αν έχετε επισκεφθεί τη συζήτηση των Frank και Tomas, ο υποκατάλογος αυτός περιέχει τα αρχεία πηγαίου κώδικα Perl για το εργαλείο openSUSE Book Builder.
    • trunk/tools/susedoc_buildbook
      Ορισμένα scripts για τη δημιουργία πακέτων RPM από πηγαίο κώδικα. Κυρίως είναι η παιδική χαρά του Karl.

Σχόλια ανατροφοδότησης μέσω των επίσημων καναλιών

Τώρα, εάν δε θέλετε να γράψετε για εμάς ή να μας αφήσετε να σας ρουφήξουμε το μεδούλι ;), υπάρχουν ακόμα αρκετά πράγματα που μπορείτε να κάνετε για να υποστηρίξετε το SUSE Doku-Wichtl:

  • Καταχωρήστε μια αναφορά σφάλματος αν βρείτε οποιοδήποτε πρόβλημα στα εγχειρίδια (πώς να αναφέρετε σφάλματα). Χρησιμοποιήστε την κατηγορία "Τεκμηρίωση".
  • Χρησιμοποιήστε τη δυνατότητα σχολιασμού από χρήστες στην online (HTML) έκδοση των εγχειριδίων μας στη διεύθυνση http://www.novell.com/documentation/. Κάθε HTML σελίδα των εγχειριδίων μας παρέχει μια επιλογή Προσθήκη σχολίου ανατροφοδότησης όπου μπορείτε να μας γνωστοποιήσετε διάφορα θέματα που αναγνωρίσατε σχετικά με τα εγχειρίδια.
  • opensuse-doc@opensuse.org - Πείτε μας τι μπορούμε να κάνουμε καλύτερα σχετικά με τα εγχειρίδιά μας και ίσως και το πώς. Στείλτε μας σχόλια σχετικά με το σύστημα τεκμηρίωσης που χρησιμοποιούμε και βοηθήστε μας να το βελτιώσουμε..
    Εγγραφή - Διαγραφή - Βοήθεια - Ιστορικό


Ή απλά πείτε μας πως θεωρείται ότι τα εγχειρίδιά μας αποτελούν τα πιο φανταστικά κομμάτια της παγκόσμιας λογοτεχνίας. ;)