Udostępnij za pośrednictwem

Informacje o witrynach typu wiki, readmes i markdown

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Możesz wspierać współautorów zespołu i projektu przy użyciu języka Markdown , aby dodać zaawansowane formatowanie, tabele i obrazy do projektu zespołowego. Format Markdown ulepsza strony wiki projektu zespołowego, zawartość, którą dodajesz do pulpitu nawigacyjnego, plik README projektu zespołowego, lub pozostałe pliki README w repozytorium.

Konfigurowanie witryny typu wiki projektu

Witryna typu wiki projektu zespołowego umożliwia udostępnianie informacji o projekcie innym członkom zespołu. Podczas konfigurowania witryny typu wiki od podstaw nowe repozytorium Git przechowuje pliki Markdown (md), obrazy, załączniki i sekwencję stron. Witryna typu wiki obsługuje wspólne edytowanie zawartości i struktury.

Poniższe linki opisują obsługiwane funkcje witryny typu wiki projektu zespołowego.

Tworzenie nowej witryny typu wiki

Praca z zawartością typu wiki

Formatowanie zawartości typu wiki

Publikowanie repozytoriów Git w witrynie typu wiki

Wiele zespołów dokumentuje swój kod przy użyciu plików Markdown, które zaewidencjonują w repozytorium wraz z kodem. Chociaż usługa Git obsługuje konserwację i przeglądanie plików dokumentacji kodu przy użyciu standardowego procesu żądania ściągnięcia, te pliki mogą stanowić wyzwanie dla konsumentów zawartości.

  • Użytkownik musi często przesiewać wiele plików i folderów, aby znaleźć interesującą zawartość.
  • Zawartość nie ma organizacji i struktury. Nie ma nieodłącznej hierarchii stron do obsługi czytelników.
  • Przechowywanie wersji zawartości nie jest obsługiwane.
  • Wyszukiwanie zawartości polega na wyszukiwaniu kodu, a nie na wyszukiwaniu zoptymalizowanym pod kątem wyszukiwania zawartości.

Funkcja Publikuj kod jako wiki umożliwia opublikowanie co najmniej jednego repozytorium Git zdefiniowanego w projekcie zespołowym w witrynie typu wiki. Ta funkcja umożliwia synchroniczną konserwację dokumentacji kodu przy użyciu bazy kodu oraz selektywne publikowanie i aktualizowanie dokumentacji w witrynie typu wiki.

Istnieją znaczące różnice między sposobem zarządzania zawartością w witrynie typu wiki dla projektu zespołowego a stronami typu wiki publikowanymi z repozytorium Git. Aby uzyskać szczegółowe informacje, zobacz Publikowanie repozytorium Git w witrynie typu wiki.

Ulepszanie zawartości projektu przy użyciu języka Markdown

Format języka Markdown ułatwia formatowanie tekstu i dołączanie obrazów. Możesz również dodawać odnośniki do dokumentów na stronach projektu, plikach README, pulpitach nawigacyjnych i prośbach o połączenie.

Możesz użyć języka Markdown, aby zapewnić zespołowi wskazówki w następujący sposób:

Aby uzyskać obsługiwaną składnię, zobacz Use Markdown in Azure DevOps (Używanie języka Markdown w usłudze Azure DevOps).

Dodawanie plików README projektu

Można zdefiniować plik README lub wiele plików dla każdego repozytorium lub projektu zespołowego. Zapisz plik README w języku Markdown zamiast zwykłego tekstu. Użyj stron README, aby zorientować współautorów na określone informacje lub lokalizacje w projekcie.

Rozważ dodanie następujących wskazówek:

  • Fokus projektu
  • Wymagania wstępne
  • Konfigurowanie środowiska
  • Porady dotyczące wykonywania zadań w projekcie
  • Cel lub użycie określonych plików
  • Terminy i akronimy specyficzne dla projektu
  • Wskazówki dotyczące procesów pracy związanych z zatwierdzaniem lub przesyłaniem zmian i dodawaniem gałęzi
  • Sponsorzy projektu lub kontakty

Przykłady README

Oto kilka przykładów projektów READMEs w usłudze GitHub, które obsługują wszystkie grupy odbiorców na potrzeby odwołań i inspiracji: