Βασικά στοιχεία Git και GitHub για την τεκμηρίωση του Microsoft Learn

Επισκόπηση

Ως συμβάλλων στην τεκμηρίωση του Microsoft Learn, θα αλληλεπιδράσετε με πολλά εργαλεία και διαδικασίες. Θα εργαστείτε παράλληλα με άλλους συμβάλλοντες στο ίδιο έργο, ενδεχομένως στο ίδιο ακριβώς περιεχόμενο, ακόμη και κατά την ίδια στιγμή. Αυτό όλα είναι δυνατά μέσω του λογισμικού Git και GitHub.

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

Το GitHub είναι μια υπηρεσία φιλοξενίας μέσω Web για αποθετήρια δεδομένων Git, όπως αυτά που χρησιμοποιούνται για την αποθήκευση περιεχομένου του Microsoft Learn . Για κάθε έργο, το GitHub φιλοξενεί το κύριο αποθετήριο δεδομένων, από το οποίο οι συμβάλλοντες μπορούν να δημιουργήσουν αντίγραφα για τη δική τους εργασία.

Αυτό το άρθρο ορίζει βασικούς όρους που αποτελούν μέρος της ροής εργασιών του Microsoft Learn. Παρέχει επίσης μια επισκόπηση των αποθετηρίων δεδομένων Git και GitHub και εξηγεί τον τρόπο με τον οποίο το περιεχόμενο είναι οργανωμένο για τεχνική τεκμηρίωση της Microsoft.

Διακλάδωση

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

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

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

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

Διακλάδωση

Αυτός ο όρος χρησιμοποιείται συνήθως ως ουσιαστικός όταν γίνεται αναφορά σε ένα αντίγραφο ενός κύριου αποθετηρίου δεδομένων GitHub. Στην πράξη, ένα διπλότυπο είναι απλώς ένα άλλο αποθετήριο δεδομένων. Η ιδιαιτερότητά του είναι ότι το GitHub διατηρεί μια σύνδεση με το κύριο/γονικό αποθετήριο δεδομένων. Αυτός ο όρος χρησιμοποιείται μερικές φορές ως ρήμα, όπως "Πρέπει πρώτα να δημιουργήσετε ένα διακλάδωμα του αποθετηρίου δεδομένων".

Git

Εάν είστε εξοικειωμένοι με τα κεντρικά συστήματα ελέγχου εκδόσεων (όπως Διακομιστής υποδομής ομάδας , το SharePoint ή την προέλευση απεικόνισης Θυρίδα), θα παρατηρήσετε ότι το Git έχει μια μοναδική ροή εργασίας συμβολής και ορολογία για την υποστήριξη του κατανεμημένου μοντέλου του. Για παράδειγμα, δεν υπάρχει κλείδωμα αρχείων που σχετίζεται συνήθως με τις λειτουργίες ανάληψης ελέγχου/μεταβίβασης ελέγχου. Αντίθετα, το Git ανησυχεί για τις αλλαγές σε ακόμα λεπτομερότερο επίπεδο, συγκρίνοντας τα αρχεία byte byte.

Το Git χρησιμοποιεί επίσης μια κλιμακωτή δομή για την αποθήκευση και τη διαχείριση του περιεχομένου ενός έργου:

• Αποθετήριο δεδομένων: γνωστό και ως repo (αποθετήριο), αποτελεί τη μεγαλύτερη μονάδα αποθήκευσης. Ένα αποθετήριο δεδομένων περιέχει έναν ή περισσότερους κλάδους.
• Κλάδος: μια μονάδα αποθήκευσης που περιέχει τα αρχεία και τους φακέλους που αποτελούν το σύνολο του περιεχομένου του έργου. Για περισσότερες πληροφορίες σχετικά με τους κλάδους, ανατρέξτε στην ενότητα Κλάδος αυτού του άρθρου.

Οι συμβάλλοντες αλληλεπιδρούν με το Git για να ενημερώνουν και να χειρίζονται αποθετήρια δεδομένων σε τοπικό επίπεδο και επίπεδο GitHub:

• Τοπικά μέσω εργαλείων όπως η κονσόλα Git Bash, που υποστηρίζει εντολές Git για τη διαχείριση τοπικών αποθετηρίων δεδομένων και επικοινωνία με αποθετήρια GitHub.
• Μέσω της τοποθεσίας www.github.com, που ενσωματώνει το Git για τη διαχείριση της διευθέτησης των συμβολών που ρέουν ξανά στο κύριο αποθετήριο δεδομένων.

GitHub

Σημείωμα

Παρόλο που οι οδηγίες τεκμηρίωσης βασίζονται στη χρήση του GitHub, ορισμένες ομάδες χρησιμοποιούν το Visual Studio Team Services για τη φιλοξενία αποθετηρίων δεδομένων Git. Το πρόγραμμα-πελάτης Visual Studio Team Explorer παρέχει ένα GUI για αλληλεπίδραση με αποθετήρια δεδομένων του Team Services, ως εναλλακτική λύση στη χρήση εντολών Git μέσω γραμμής εντολών.
Επίσης, πολλές από τις παρακάτω οδηγίες αναπτύχθηκαν ως βέλτιστες πρακτικές από πολλά χρόνια εμπειρίας στη φιλοξενία περιεχομένου της υπηρεσίας Azure στο GitHub. Μπορεί να απαιτούνται σε ορισμένα αποθετήρια δεδομένων του Microsoft Learn.

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

Οργάνωση καταλόγου

Ο προεπιλεγμένος κλάδος ενός έργου χρησιμεύει ως η τρέχουσα έκδοση περιεχομένου για το έργο. Το περιεχόμενο της προεπιλεγμένης διακλάδωσης και των διακλαδώσεις που δημιουργούνται από αυτήν ευθυγραμμίζεται χαλαρά με την οργάνωση των άρθρων στις αντίστοιχες σελίδες του Microsoft Learn. Οι υποκαταλόγοι χρησιμοποιούνται για τον διαχωρισμό άρθρων όπως (όπως υπηρεσιών), πολυμέσων (όπως αρχείων εικόνας) και αρχείων "συμπερίληψης" (τα οποία επιτρέπουν την επαναχρησιμοποίηση του περιεχομένου).

Υποκατάλογος άρθρων

Συνήθως μπορείτε να βρείτε έναν κύριο articles κατάλογο στη ρίζα του αποθετηρίου δεδομένων. Ο articles κατάλογος περιέχει ένα σύνολο υποκαταλόγων Άρθρα στους υποκαταλόγους που μορφοποιούνται ως αρχεία Markdown που χρησιμοποιούν επέκταση .md . Ορισμένα αποθετήρια δεδομένων που υποστηρίζουν πολλές υπηρεσίες χρησιμοποιούν έναν γενικό υποκατάλογο /articles, όπως το αποθετήριο δεδομένων Azure-Docs. Άλλα μπορεί να χρησιμοποιούν ένα όνομα συγκεκριμένης υπηρεσίας, όπως το αποθετήριο δεδομένων IntuneDocs, το οποίο χρησιμοποιεί/IntuneDocs.

Στη ρίζα αυτού του καταλόγου, μπορείτε να βρείτε γενικά άρθρα που σχετίζονται με τη συνολική υπηρεσία ή προϊόν. Και, συνήθως, μπορείτε να βρείτε άλλη μια σειρά από υποκαταλόγους που σχετίζονται με τα χαρακτηριστικά/υπηρεσίες ή τα τυπικά σενάρια. Για παράδειγμα, τα άρθρα Azure "εικονικής μηχανής" είναι στον υποκατάλογο /virtual-machines και τα άρθρα "κατανόησης και εξερεύνησης" του Intune στον υποκατάλογο /understand-explore.

Υποκατάλογος πολυμέσων

Κάθε κατάλογος άρθρων περιέχει έναν υποκατάλογο /media για αντίστοιχα αρχεία πολυμέσων. Τα αρχεία πολυμέσων περιέχουν εικόνες που χρησιμοποιούνται από τα άρθρα που έχουν αναφορές εικόνων.

Περιλαμβάνει υποκατάλογο

Κάθε φορά που έχουμε περιεχόμενο με δυνατότητα επανάληψης χρήσης που είναι κοινή σε δύο ή περισσότερα άρθρα, τοποθετείται σε έναν υποκατάλογο /includes εκτός του κύριου καταλόγου articles. Σε ένα αρχείο Markdown που χρησιμοποιεί το αρχείο συμπερίληψης, τοποθετείται μια αντίστοιχη επέκταση Markdown "συμπερίληψης" στη θέση όπου πρέπει να αναφερθεί το αρχείο συμπερίληψης.

Ανατρέξτε στο θέμα Αναφορά Markdown: Περιλαμβάνει για πρόσθετες οδηγίες.

Πρότυπο αρχείου Markdown

Για μεγαλύτερη ευκολία, ο ριζικός κατάλογος κάθε αποθετηρίου δεδομένων περιέχει συνήθως ένα αρχείο προτύπου Markdown, με το όνομα template.md. Μπορείτε να χρησιμοποιήσετε αυτό το αρχείο προτύπου ως "αρχείο εκκίνησης" εάν θέλετε να δημιουργήσετε ένα νέο άρθρο για υποβολή στο αποθετήριο δεδομένων. Το αρχείο περιέχει:

• Μια κεφαλίδα μετα-δεδομένων στο επάνω μέρος του αρχείου, που οριοθετείται από δύο γραμμές με 3 ενωτικά. Περιέχει τις διάφορες ετικέτες που χρησιμοποιούνται για την παρακολούθηση πληροφοριών σχετικά με το άρθρο. Τα μετα-δεδομένα του άρθρου ενεργοποιούν ορισμένες λειτουργίες, όπως αναφορά συντάκτη, αναφορά συμβάλλοντος, δυναμικές διαδρομές και περιγραφές άρθρου. Περιλαμβάνει επίσης βελτιστοποιήσεις SEO και διεργασίες αναφοράς που χρησιμοποιεί η Microsoft για την αξιολόγηση της απόδοσης του περιεχομένου. Επομένως, τα μετα-δεδομένα είναι σημαντικά!
• Μια ενότητα μετα-δεδομένων που περιγράφει τις διάφορες ετικέτες και τιμές μετα-δεδομένων. Εάν δεν είστε βέβαιοι για τις τιμές που πρέπει να χρησιμοποιήσετε για την ενότητα μετα-δεδομένων, μπορείτε να τις αφήσετε κενές ή να τις σχολιάσετε με ένα hashtag στην αρχή (#) και θα ελεγχθούν/συμπληρωθούν από τον αναθεωρητή του αιτήματος έλξης για το αποθετήριο δεδομένων.
• Διάφορα παραδείγματα χρήσης Markdown για τη μορφοποίηση των στοιχείων ενός άρθρου.
• Γενικές οδηγίες σχετικά με τη χρήση επεκτάσεων Markdown, που μπορείτε να χρησιμοποιήσετε για τους διάφορους τύπους ειδοποιήσεων.
• Παραδείγματα ενσωμάτωσης βίντεο με τη χρήση ενός iframe.
• Γενικές οδηγίες σχετικά με τη χρήση επεκτάσεων τεχνικής τεκμηρίωσης της Microsoft, τις οποίες μπορείτε να χρησιμοποιήσετε για ειδικά στοιχεία ελέγχου, όπως κουμπιά και επιλογείς.

Προέλευση

Αυτός ο όρος είναι το όνομα που εκχωρείται στη σύνδεση μεταξύ του τοπικού αποθετηρίου δεδομένων και του αποθετηρίου δεδομένων από το οποίο έχει κλωνοποιηθεί. Στη ροή εργασιών του Microsoft Learn, η προέλευση αντιπροσωπεύει τη σύνδεση με τη διακλάδωσή σας. Αυτός ο όρος χρησιμοποιείται μερικές φορές ως αναγνωριστικό για το ίδιο το αποθετήριο δεδομένων προέλευσης, όπως "Θυμηθείτε να προωθήσετε τις αλλαγές σας στην προέλευση".

Αιτήματα έλξης

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

Ένα αίτημα έλξης χρησιμεύει επίσης ως ένας μηχανισμός για την παροχή σχολίων στον συμβάλλοντα από τις διαδικασίες επικύρωσης του Microsoft Learn και τον αναθεωρητή αιτημάτων έλξης για την επίλυση ζητημάτων ή ερωτήσεων πριν συγχωνευτούν οι αλλαγές στον προεπιλεγμένο κλάδο.

Απομακρυσμένης

Ένας απομακρυσμένος είναι μια επώνυμη σύνδεση σε ένα απομακρυσμένο αποθετήριο δεδομένων, όπως απομακρυσμένη "προέλευση" ή "upstream". Το Git αναφέρεται σε αυτό το στοιχείο ως απομακρυσμένο, επειδή χρησιμοποιείται για την αναφορά σε ένα αποθετήριο δεδομένων που φιλοξενείται σε έναν άλλο υπολογιστή. Στη ροή εργασιών του Microsoft Learn, ένα απομακρυσμένο στοιχείο είναι πάντα ένα αποθετήριο δεδομένων GitHub.

Ανάντη

Όπως και η απομακρυσμένη προέλευση, η upstream είναι μια επώνυμη σύνδεση σε ένα άλλο αποθετήριο δεδομένων. Στη ροή εργασιών του Microsoft Learn, η ανομοιόμορφη σύνδεση αντιπροσωπεύει τη σύνδεση μεταξύ του τοπικού αποθετηρίου δεδομένων και του κύριου αποθετηρίου δεδομένων από το οποίο δημιουργήθηκε το διακλάδωμά σας. Αυτός ο όρος χρησιμοποιείται μερικές φορές ως αναγνωριστικό για το ίδιο το ανηφορικό αποθετήριο, όπως "Θυμηθείτε να τραβήξετε τις τελευταίες αλλαγές από την ανόθευτη".

Μάθετε περισσότερα

Εάν δεν είστε εξοικειωμένοι με το Git ή το GitHub, αυτοί οι πόροι μπορούν να σας βοηθήσουν να μάθετε, να παραγωγικοί ή να απαντήσετε σε ερωτήσεις.

Πόροι ελέγχου προέλευσης Git

• Pro Git e-book (web): Μια διεξοδική αναφορά στο Git, σε μορφή HTML.
• Pro Git e-book (PDF): Όπως και η προηγούμενη σύνδεση, σε μορφή PDF.
• Κύκλος μαθημάτων εκμάθησης του Git από το Codecademy
• Κύκλος μαθημάτων δοκιμής του Git από το Code School στο Pluralsight

Πόροι για το GitHub

• Άσκηση γρήγορης εκκίνησης GitHub Hello World: Εκπαιδευτικό βοήθημα σε σύνδεση που σας εκθέτει στα βασικά στοιχεία του Git χρησιμοποιώντας το GitHub.
• Οδηγοί GitHub: Το μέρος όπου συγκεντρώνεται η τεκμηρίωση για το GitHub.
• Πόροι εκμάθησης του GitHub: Άλλοι χρήσιμοι πόροι για το GitHub.
• Γλωσσάρι: Ένα εύχρηστο γλωσσάρι με τους όρους του Git και του GitHub.
• Πακέτο σπουδαστών-προγραμματιστών GitHub: Δωρεάν πρόσβαση στα καλύτερα εργαλεία για προγραμματιστές για σπουδαστές.

Συνήθεις ερωτήσεις

Τι είναι το Git;

Το Git σάς βοηθά να παρακολουθείτε τις αλλαγές όταν πολλοί χρήστες εργάζονται μαζί στον κώδικα υπολογιστή. Είναι σαν μια χρονομηχανή για κώδικα, ώστε να μπορείτε να δείτε τι έχει αλλάξει και να επιστρέψετε εάν είναι απαραίτητο.

Γιατί να χρησιμοποιήσω το Git;

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

Πώς λειτουργεί το Git;

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

Τι είναι οι κλάδοι στο Git;

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

Τι είναι μια δέσμευση στο Git;

Μια δέσμευση είναι σαν ένα σημείο αποθήκευσης. Είναι ένας τρόπος για να καταγράψετε τις αλλαγές που κάνατε. Κάθε δέσμευση διαθέτει ένα μοναδικό αναγνωριστικό και μια σημείωση σχετικά με το τι άλλαξε.

Τι είναι το GitHub;

Το GitHub είναι ένας ιστότοπος όπου μπορείτε να αποθηκεύσετε τα έργα σας Git. Είναι ένα μεγάλο κομβικό σημείο για την κοινή χρήση και συνεργασία σε κώδικα με άλλους χρήστες. Βοηθά επίσης να παρακολουθεί ποιος άλλαξε τι.

Σε τι διαφέρει το GitHub από το Git;

Το Git είναι το εργαλείο για την παρακολούθηση των αλλαγών, ενώ το GitHub είναι το σημείο αποθήκευσης των έργων σας και συνεργασία. Το GitHub χρησιμοποιεί το Git για να κάνει τη μαγεία του.

Είναι το GitHub δωρεάν;

Ναι, για έργα που μπορούν να δουν όλοι. Ωστόσο, για ιδιωτικά έργα (μόνο εσείς και η ομάδα σας), ίσως χρειαστεί να πληρώσετε. Προσφέρουν διαφορετικά προγράμματα με επιπλέον δυνατότητες.

Τι είναι τα αιτήματα έλξης στο GitHub;

Τα αιτήματα έλξης είναι όπως όταν ζητάτε να τοποθετήσετε τις αλλαγές σας στο κύριο έργο. Άτομα μπορούν να εξετάσουν και να συζητήσουν τις αλλαγές πριν προστεθούν.

Πόσο ασφαλές είναι το GitHub;

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