Βελτιώστε αυτό το εγχειρίδιο¶
Το εγχειρίδιο συντηρείται σε μορφή Markdown στον κατάλογο docs/ και δημιουργείται με το MkDocs.
Τοπική προεπισκόπηση¶
Δημιουργήστε ένα εικονικό περιβάλλον και εγκαταστήστε τις εξαρτήσεις τεκμηρίωσης:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Ανοίξτε την τοπική διεύθυνση που εκτυπώθηκε από το MkDocs. Η προεπισκόπηση αναδημιουργείται όταν αλλάζει ένα αρχείο προέλευσης.
Επικυρώστε τον ιστότοπο¶
Πριν ανοίξετε ένα pull request:
Η δημιουργία με αυστηρό έλεγχο αναφέρει καταχωρίσεις πλοήγησης που λείπουν, μη έγκυρους συνδέσμους που εντοπίζει το MkDocs και προειδοποιήσεις διαμόρφωσης.
Αρχές γραφής¶
- Γράψτε για μια συγκεκριμένη εργασία και ένα συγκεκριμένο κοινό.
- Δηλώστε την έκδοση MRBS όταν η συμπεριφορά είναι συγκεκριμένη για την έκδοση.
- Προτιμήστε τα δοκιμασμένα παραδείγματα από τις εξαντλητικές λίστες.
- Μην συμπεριλάβετε ποτέ πραγματικά διαπιστευτήρια ή προσωπικά δεδομένα κράτησης.
- Συνδέστε τις σχετικές εργασίες αντί να αντιγράψετε μεγάλες ενότητες.
- Ενημερώστε όλες τις διαθέσιμες μεταφράσεις όταν είναι πρακτικό.
Μεταφράσεις¶
Το αγγλικό κείμενο αποτελεί την έκδοση αναφοράς. Οι μεταφρασμένες σελίδες χρησιμοποιούν την ίδια σχετική διαδρομή, με την προσθήκη του αναγνωριστικού γλώσσας:
Όταν λείπει μια μετάφραση, ο ιστότοπος εμφανίζει το αγγλικό κείμενο. Η μετάφραση πρέπει να διατηρεί αναλλοίωτα τον κώδικα, τα ονόματα ρυθμίσεων, τις προειδοποιήσεις και τους συνδέσμους, χρησιμοποιώντας παράλληλα φυσική και καθιερωμένη ορολογία στη γλώσσα-στόχο.
Πεδίο εφαρμογής¶
Αυτό το δέντρο τεκμηρίωσης στοχεύει το MRBS 1.12.2. Οι αλλαγές που περιγράφουν μια μεταγενέστερη έκδοση πρέπει να ενημερώσουν το εύρος της ορατής έκδοσης ή να αναπτυχθούν στο σύνολο τεκμηρίωσης για αυτήν την έκδοση.