Podstawy współtworzenia w środowisku Microsoft Learn
Istnieją pewne terminy, które pomogą Ci zrozumieć i ukończyć proces współtworzenia. Nie jest konieczne poznanie wszystkiego, co dzieje się pod maską, ale ogólny przegląd sposobu działania współtworzenia pomaga zrozumieć, dlaczego proces działa w sposób, w jaki działa.
Microsoft Learn i GitHub — podstawy
Platforma Microsoft Learn zawiera tysiące artykułów, modułów szkoleniowych, stron internetowych i nie tylko, które muszą być przechowywane i regularnie dostępne przez różnych współautorów. Usługa Microsoft Learn używa usługi GitHub do przechowywania dużej ilości tej zawartości. GitHub to platforma korzystająca z usługi Git, rozproszonego systemu kontroli wersji, do przechowywania projektów i ułatwiania współpracy między wieloma uczestnikami projektu z różnymi celami i osiami czasu. Oprogramowanie Git i GitHub umożliwia równoległą pracę z innymi współautorami w tym samym projekcie, potencjalnie dokładnie taką samą zawartość, nawet w tym samym czasie, bez przypadkowego zakłócania pracy innych osób.
Zawartość jest przechowywana w plikach w repozytoriach Git (repozytoriach) hostowanych w usłudze GitHub. Repozytorium to jednostka magazynu zawierająca pliki projektu i historię poprawek plików. Repozytoria mogą być publiczne lub prywatne, a środowisko Microsoft Learn składa się z kombinacji obu tych elementów. Każdy może współtworzyć repozytorium publiczne po skonfigurowaniu konta usługi GitHub. Repozytoria prywatne są dostępne tylko dla współautorów, którzy są pracownikami firmy Microsoft lub którym udzielono specjalnych uprawnień.
Wprowadzanie zmian w zawartości usługi Microsoft Learn przechowywanej w repozytorium GitHub
W przypadku dowolnego projektu usługa GitHub hostuje główne repozytorium i wszelkie rozwidlenia. Rozwidlenie to kopia głównego repozytorium, którą współautor tworzy dla własnej pracy. Rozwidlenie to jeden ze sposobów ochrony opublikowanej zawartości w usłudze GitHub. Zamiast bezpośrednio edytować zawartość w aktywnej, opublikowanej gałęzi repozytorium głównego, usługa GitHub tworzy migawkę tej zawartości rozwidlenia, dzięki czemu możesz wprowadzić tam zmiany.
Repozytoria GitHub zawierają co najmniej jedną gałąz. Gałąź to jednostka magazynu zawierająca pliki i foldery tworzące zestaw zawartości projektu. Wszystkie repozytoria, niezależnie od tego, czy jest to repozytorium główne, czy rozwidlenie, zawierają gałąź domyślną (zazwyczaj o nazwie "main") i co najmniej jedną gałąź przeznaczoną do scalenia z gałęzią domyślną. Gałąź domyślna służy jako bieżąca wersja i "pojedyncze źródło prawdy" dla projektu. Jest to poziom nadrzędny, z którego tworzone są wszystkie inne gałęzie w repozytorium.
Edytowanie artykułu dokumentacji w repozytorium publicznym może wydawać się zaczyna się od naciśnięcia przycisku, ale za kulisami dzieje się kilka rzeczy. Po uruchomieniu procesu edytowania opartego na przeglądarce zostanie utworzone rozwidlenie repozytorium (jeśli jeszcze go nie masz) i użyte do wprowadzania zmian. Edytujesz w gałęzi rozwidlenia, która zostanie później scalona z gałęzią na żywo repozytorium głównego, aby zmiany zostały udostępnione dla wszystkich.
Tworzenie żądania ściągnięcia
Jak to się dzieje w przypadku scalania? Musisz poinformować usługę GitHub — w szczególności właścicieli głównego repozytorium i autorów artykułu — że twoje edycje są finalizowane i gotowe do przeglądu, publikowania i świata, aby zobaczyć! W tym celu należy utworzyć i przesłać żądanie ściągnięcia.
Żądanie ściągnięcia to propozycja scalenia zmian z gałęzi w rozwidleniu, w którym pracujesz, do domyślnej gałęzi "main" repozytorium na żywo. Gdy pracujesz w repozytorium publicznym, żądania ściągnięcia będą zawsze przeglądane przez recenzenta przed scaleniem. Mogą również istnieć pewne zautomatyzowane kontrole, takie jak zgodność scalania i walidacja kompilacji. Po zakończeniu tych przeglądów i rozwiązaniu wszelkich problemów zmiany zostaną scalone z gałęzią na żywo i staną się dostępne w witrynie Microsoft Learn!
Przepływ pracy dla drobnych wkładów w dokumentację
Podsumowując, wykonaj następujące ogólne kroki podczas wprowadzania małych zmian w dokumentacji firmy Microsoft przy użyciu edytora internetowego w usłudze GitHub:
- Po otwarciu pliku w przeglądarce do edycji rozwidlenie repozytorium publicznego zostanie automatycznie utworzone. Zostanie również utworzona gałąź w rozwidleniu, często nazywana gałęzią poprawek.
- Wprowadź zmiany w pliku.
- Utwórz żądanie ściągnięcia, aby zaproponować przejrzenie i scalenie zmian.
- Żądanie ściągnięcia musi rozwiązać wszelkie problemy i przekazać wszystkie recenzje.
- Twoje żądanie ściągnięcia jest scalane z główną gałęzią repozytorium na żywo, a zmiany są publikowane w witrynie Microsoft Learn.
Następnie przyjrzyjmy się bliżej każdemu krokowi, aby dowiedzieć się, jak je wykonać.