Πώς να δημιουργήσετε ένα απλό εσωτερικό Wiki χρησιμοποιώντας το Gitbook

Το GitBook είναι μια πλατφόρμα που σας επιτρέπει να δημιουργείτε ιστότοπους τεκμηρίωσης ή εταιρικά wiki. Μπορείτε να το χρησιμοποιήσετε για να τεκμηριώσετε όλα τα είδη πραγμάτων, από κώδικα έως API και πώς να χρησιμοποιήσετε ένα προϊόν λογισμικού.

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

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

Πώς να ξεκινήσετε να χρησιμοποιείτε το GitBook

Μπορείτε να επιλέξετε από πολλά Τιμολόγηση GitBook σχέδια. Η τιμολόγηση θα εξαρτηθεί από το αν χρησιμοποιείτε το GitBook για έργα ανοιχτού κώδικα, για προσωπική χρήση ή για συνεργασία με ιδιωτική ομάδα. Το GitBook είναι δωρεάν για χρήση εάν το χρησιμοποιείτε για έργα ανοιχτού κώδικα.

Το GitBook υποστηρίζει Markdown, μια δημοφιλής γλώσσα σήμανσης με πολλά πλεονεκτήματα για γραφή ή τεκμηρίωση στον Ιστό.

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

1. Εγγραφείτε στο GitBook. Εάν έχετε τον δικό σας λογαριασμό GitHub, μπορείτε να κάνετε κλικ Εγγραφείτε με το GitHub.
2. Μόλις συνδεθείτε, το GitBook θα σας ανακατευθύνει σε ένα νέο εσωτερικό wiki. Επίσης, θα συμπληρώσει εκ των προτέρων το wiki σας με κάποιο δείγμα περιεχομένου.

Μια επισκόπηση της διεπαφής GitBook

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

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

Πώς να δημιουργήσετε ένα νέο προσχέδιο

Μπορείτε να δημιουργήσετε ένα νέο προσχέδιο δημιουργώντας ένα νέο αίτημα αλλαγής και κάνοντας αλλαγές σε αυτό.

1. Στον επάνω πίνακα, κάντε κλικ στο Αιτήματα αλλαγής.
2. Στο νέο πλαίσιο που εμφανίζεται στη δεξιά πλευρά, κάντε κλικ στο Προσχέδιο αυτί. Αυτό θα σας δείξει όλα τα ενεργά πρόχειρά σας.
3. Από εδώ, μπορείτε να κάνετε κλικ σε ένα υπάρχον προσχέδιο για να το ανοίξετε. Για να δημιουργήσετε ένα νέο προσχέδιο, κάντε κλικ στο Νέο αίτημα αλλαγήςκαι περιμένετε να ολοκληρωθεί η φόρτωση της σελίδας.
4. Στον κάτω πίνακα, κάντε κλικ στο Εισαγάγετε ένα Θέμα. Αυτό θα ανοίξει ένα παράθυρο όπου μπορείτε να δώσετε ένα όνομα στο νέο πρόχειρο. Για παράδειγμα, Νέα σελίδα - Πώς να ρυθμίσετε το Codebase.

Πώς να δημιουργήσετε σελίδες και ομάδες

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

1. Δημιουργήστε μια νέα σελίδα κάνοντας κλικ στο ΝΕΑ ΣΕΛΙΔΑ συνδέσμου στο κάτω μέρος της πλαϊνής γραμμής και επιλέγοντας Νέα σελίδα εγγράφου από το αναπτυσσόμενο μενού. Εναλλακτικά, μπορείτε να τοποθετήσετε το δείκτη του ποντικιού κάτω από μια υπάρχουσα σελίδα και να κάνετε κλικ στο μπλε συν κουμπί.
2. Για να δημιουργήσετε μια νέα ομάδα σελίδων, κάντε κλικ στο ΝΕΑ ΣΕΛΙΔΑκαι επιλέξτε το Νέα ομάδα επιλογή από το αναπτυσσόμενο μενού.
3. Μπορείτε να μετονομάσετε τη σελίδα κάνοντας κλικ στις τρεις τελείες δίπλα στη σελίδα ή την ομάδα και επιλέγοντας Μετονομάζω.
4. Ξεκινήστε να προσθέτετε περιεχόμενο για να συμπληρώσετε τη νέα σας σελίδα. Μπορείτε να προσθέσετε απλό περιεχόμενο, όπως κείμενο ή επικεφαλίδες. Το GitBook σάς επιτρέπει επίσης να προσθέσετε άλλα μπλοκ περιεχομένου, όπως εικόνες, συνημμένα αρχεία, πίνακες, καρτέλες ή αποσπάσματα κώδικα. Υπάρχει επίσης η επιλογή προσθήκης άλλων ενσωματώσεων, όπως ενσωματώσεις YouTube ή περιεχόμενο των Εγγράφων Google.
5. Κάνε κλικ στο Διαφορική προβολή κουμπί στο κάτω πλαίσιο για να δείτε τις διαφορές μεταξύ του προχείρου σας και του αρχικού αντιγράφου κύριας τεκμηρίωσης.
6. Μόλις ολοκληρώσετε τη σύνταξη του περιεχομένου σας, μπορείτε να κάνετε κλικ στο Συγχώνευση, Υποβολή και συγχώνευση, ή Υποβολή για έλεγχο.

Μπορείτε να αποκτήσετε πρόσβαση στον σύνδεσμο κοινής χρήσης από τον επάνω πίνακα του GitBook. Θα πρέπει να είστε εκτός σχεδίου και να προβάλετε το κύριο αντίγραφο τεκμηρίωσης για να μπορέσετε να δείτε τον σύνδεσμο.

1. Από προεπιλογή, η ορατότητα της τοποθεσίας τεκμηρίωσής σας είναι "μη καταχωρισμένη". Αυτό σημαίνει ότι μπορείτε να έχετε πρόσβαση στον ιστότοπο τεκμηρίωσης χρησιμοποιώντας έναν ιδιωτικό σύνδεσμο και όχι μέσω μηχανών αναζήτησης. Στον επάνω πίνακα, κάντε κλικ στο Ακαταχώριστος κουμπί.
2. Επιλέξτε τις επιθυμητές ρυθμίσεις ορατότητας από το αναπτυσσόμενο μενού. Λάβετε υπόψη ότι το GitBook ενδέχεται να κλειδώσει ορισμένες ρυθμίσεις ορατότητας και ίσως χρειαστεί να κάνετε αναβάθμιση για να αποκτήσετε πρόσβαση σε αυτές.
3. Κάτω από τη λίστα των ρυθμίσεων ορατότητας, υπάρχει ένας σύνδεσμος που μπορείτε να μοιραστείτε με άλλους χρήστες που θα χρησιμοποιούν τον ιστότοπο τεκμηρίωσής σας. Αντιγράψτε αυτόν τον σύνδεσμο για να τον μοιραστείτε με άλλους.
4. Κάτω από τον σύνδεσμο, κάντε κλικ στο Ρυθμίσεις συνδέσμου και τομέα. Εδώ μπορείτε να συνδέσετε ένα προσαρμοσμένο όνομα τομέα ή να τροποποιήσετε μέρος της διεύθυνσης URL. Εάν χρησιμοποιείτε έναν προσαρμοσμένο τομέα, μπορείτε να προβάλετε τεκμηρίωση του Gitbook πώς να ρυθμίσετε σωστά το DNS σας.

Δημιουργία τεκμηρίωσης με χρήση του GitBook

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

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

Εάν δημιουργείτε εσωτερική τεκμηρίωση για τον κώδικα Java σας, ίσως θελήσετε να εξερευνήσετε το Javadoc. Το Javadoc σάς επιτρέπει να τεκμηριώνετε αυτόματα τον κώδικα Java σας.