Επεξεργασία τεκμηρίωσης του Microsoft Learn στο πρόγραμμα περιήγησης

Φιλοδώρημα

Για αυτό το θέμα, διατίθεται ένας αναλυτικός μαθησιακός δίαυλος βήμα προς βήμα.

Πολλά από τα σύνολα τεκμηρίωσης της Microsoft είναι ανοιχτού κώδικα και φιλοξενούνται στο GitHub. Παρόλο που δεν είναι όλα τα σύνολα τεκμηρίωσης πλήρως ανοιχτού κώδικα, πολλά από αυτά διαθέτουν δημόσια αποθετήρια δεδομένων, όπου μπορείτε να προτείνετε αλλαγές μέσω αιτημάτων έλξης (ΑΙΤΉΜΑΤα έλξης). Αυτή η προσέγγιση ανοιχτού κώδικα απλοποιεί και βελτιώνει την επικοινωνία μεταξύ μηχανικών προϊόντων, ομάδων περιεχομένου και πελατών.

Οι γρήγορες επεξεργασίες διευκολύνουν τη διαδικασία αναφοράς και επιδιόρθωσης μικρών σφαλμάτων και παραλείψεων στην τεκμηρίωση. Παρ’ όλες τις προσπάθειες, στα δημοσιευμένα έγγραφα μπορεί να φτάνουν γραμματικά και ορθογραφικά μικρολάθη. Εκτιμούμε τη βοήθειά σας για τον εντοπισμό και τη διόρθωση αυτών των προβλημάτων!

Χρησιμοποιούμε αιτήματα έλξης για όλες τις αλλαγές, ακόμη και για συμβάλλοντες που έχουν πρόσβαση εγγραφής. Τα περισσότερα αποθετήρια προστατεύουν τον προεπιλεγμένο κλάδο, επομένως, οι ενημερώσεις πρέπει να υποβάλλονται ως αιτήματα έλξης.

Προαπαιτούμενα στοιχεία

• Δημιουργήστε έναν λογαριασμό GitHub, εάν δεν έχετε λογαριασμό.

Επεξεργασία εγγράφου στο πρόγραμμα περιήγησης

1. Μεταβείτε στην τεκμηρίωση που θέλετε να επεξεργαστείτε. Ορισμένες σελίδες εγγράφων σάς επιτρέπουν να επεξεργάζεστε περιεχόμενο απευθείας στο πρόγραμμα περιήγησης. Σε αυτή την περίπτωση, θα δείτε ένα εικονίδιο μολυβιού Επεξεργασία όπως αυτό που εμφανίζεται παρακάτω. Η επιλογή του εικονιδίου μολυβιού Επεξεργασία σάς μεταφέρει στο αρχείο προέλευσης στο GitHub.

   

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

2. Επιλέξτε το εικονίδιο μολυβιού Επεξεργασία στο επάνω μέρος της σελίδας αρχείου GitHub. Εάν το εικονίδιο μολυβιού Επεξεργασία δεν είναι διαθέσιμο (εμφανίζεται αχνό) ή δεν εμφανίζεται, πρέπει να συνδεθείτε στον λογαριασμό σας GitHub.

   

   Στο επάνω μέρος του άρθρου υπάρχουν τα μετα-δεδομένα του άρθρου. Τα μετα-δεδομένα εφαρμόζονται σε άρθρα για αναφορά, δυνατότητα εντοπισμού μέσω αναζήτησης και προώθηση πτυχών της εμπειρίας τοποθεσίας. Εάν κάνετε μικρές ενημερώσεις σε ένα δημοσιευμένο άρθρο, πιθανότατα δεν θα χρειαστεί να αλλάξετε τα μετα-δεδομένα.

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

4. Επεξεργαστείτε το αρχείο στο πρόγραμμα επεξεργασίας web. Επιλέξτε την καρτέλα Προεπισκόπηση στη γραμμή εργαλείων για να ελέγξετε τη μορφοποίηση των αλλαγών σας.

5. Όταν ολοκληρώσετε την επεξεργασία, επιλέξτε το κουμπί Δέσμευση αλλαγών ή Πρόταση αλλαγών , συνήθως στην επάνω δεξιά γωνία της οθόνης.

6. Εισαγάγετε ένα μήνυμα δέσμευσης. Το μήνυμα δέσμευσης γίνεται ο τίτλος του pr σας και θα πρέπει να είναι μια σύντομη σύνοψη των αλλαγών σας (για παράδειγμα, "Επιδιόρθωση ορθογραφικών σφαλμάτων και γραμματικών σφαλμάτων"). Προαιρετικά, προσθέστε μια Εκτεταμένη περιγραφή για να δώσετε περισσότερες λεπτομέρειες σχετικά με τις αλλαγές σας. Επιλέξτε Πρόταση αλλαγών:

   

7. Τώρα που προτείνατε και δεσμεύσατε τις αλλαγές σας, πρέπει να ζητήσετε από τους κατόχους του αποθετηρίου δεδομένων να "τραβήξουν" τις αλλαγές σας στο αποθετήριό τους. Αυτό γίνεται με χρήση αιτήματος έλξης (PR). Όταν επιλέξετε Πρόταση αλλαγών, θα δείτε μια σελίδα όπως αυτή:

   

   Το αίτημα έλξης σας προτείνει αλλαγές από τη διακλάδωση και τον κλάδο σας (αντιπροσωπεύονται από τα δύο στοιχεία στη δεξιά πλευρά του βέλους) στο κύριο πιρούνι και main διακλάδωση του αποθετηρίου τεκμηρίωσης (αντιπροσωπεύονται από τα δύο στοιχεία στην αριστερή πλευρά του βέλους).

   Εξετάστε τις αλλαγές σας και, στη συνέχεια, επιλέξτε Δημιουργία αιτήματος έλξης.

8. Στη σελίδα Άνοιγμα αιτήματος έλξης, κάντε προεπισκόπηση του αιτήματος έλξης σας. Μπορείτε να αλλάξετε τα πεδία τίτλου ή περιγραφής, εάν είναι απαραίτητο. Όταν είστε έτοιμοι, επιλέξτε Δημιουργία αιτήματος έλξης. Αυτή η ενέργεια ανοίγει το αίτημα έλξης σας και ειδοποιεί τον κάτοχο του άρθρου που προτείνετε μια αλλαγή.

9. Αυτό ήταν! Τα μέλη της ομάδας περιεχομένου θα ελέγξουν το αίτημα έλξης σας και θα το συγχωνεύσουν όταν εγκριθεί. Ενδέχεται να λάβετε σχόλια που ζητούν αλλαγές. Για περισσότερες λεπτομέρειες σχετικά με την επεξεργασία του αιτήματος έλξης, ανατρέξτε στο θέμα Επεξεργασία αιτήματος έλξης.

Περιορισμοί

• Το πιο μεταφρασμένο περιεχόμενο (δηλαδή μεταφρασμένο) περιεχόμενο δεν προσφέρει τη δυνατότητα επεξεργασίας μέσω του GitHub. Ωστόσο, μπορείτε να παρέχετε σχόλια σχετικά με την ποιότητα της μετάφρασης, επιλέγοντας το κουμπί Σχόλια (αντίχειρες) στο επάνω μέρος της σελίδας και, στη συνέχεια, επιλέγοντας τον Λόγο ποιότητας μετάφρασης. Μπορείτε επίσης να αφήσετε πιο συγκεκριμένα σχόλια για μεταφρασμένο περιεχόμενο, χρησιμοποιώντας τη φόρμα Παροχή σχολίων .
• Η εμπειρία επεξεργασίας εντός του προγράμματος περιήγησης λειτουργεί καλύτερα για μικρές και σπάνιες αλλαγές. Εάν πραγματοποιείτε συμβολές μεγάλης κλίμακας ή χρησιμοποιείτε προηγμένες δυνατότητες του Git (όπως διαχείριση διακλάδωσης ή σύνθετη επίλυση διένεξης συγχώνευσης), συνιστούμε να δημιουργήσετε ένα διακλάδωση του αποθετηρίου και να εργάζεστε τοπικά.