Aktualizacja migracji witryn MSDN i TechNet do witryny docs.microsoft.com

  • Artykuł

Autorem tego wpisu jest Jeff Sandquist, wiceprezes ds. korporacyjnych oraz relacji z deweloperami.

Dzisiaj z przyjemnością przedstawiamy ważną aktualizację dotyczącą migracji zawartości witryn MSDN i TechNet do witryny docs.microsoft.com. Ten wpis w blogu zawiera informacje na temat ostatnich kilku etapów działań całej firmy zmierzających do zmodernizowania struktury zawartości, formatu i podstawowej infrastruktury oraz scentralizowania dokumentacji technicznej firmy Microsoft w ramach jednej witryny.

Z witryn MSDN i TechNet do witryny docs.microsoft.com

Usługa Microsoft Developer Network narodziła się w 1992 roku jako usługa subskrypcji klienta, aby zapewnić informacje techniczne na temat programowania dla systemu Windows. Sześć lat później, w 1998 roku, została uruchomiona witryna MSDN Online hostująca ponad 250 000 stron zawartości.

Zrzut ekranu przedstawiający witrynę MSDN Online w 1999 r.

Wówczas proces publikowania polegał na tworzeniu treści w programie Microsoft Word, konwertowaniu jej na kod HTML i publikowaniu za pomocą narzędzia o nazwie pubwiz (Kreator publikowania). Przez ponad 20 lat proces ten wspierał wprowadzanie nowych produktów, usług i aktualizacji, czego rezultatem było oszałamiające 45 milionów stron zawartości technicznej!

Ponieważ cykl wydawania produktu skrócił się z lat do miesięcy, zapotrzebowanie na dostępną aktualną dokumentację rosło. System publikowania musiał dopasować się do prędkości inżynierskiej, dlatego postanowiliśmy na nowo wynaleźć sposób zarządzania dokumentacją w firmie Microsoft w erze chmury. W listopadzie 2015 roku członkowie założyciele zespołu witryny docs.microsoft.com — Dan Fernandez, Mary McHale, Carol Zeumault i Jeff Sandquist — napisali dokument o nazwie „A New Hope” (hołd dla filmu „Gwiezdne wojny: część IV — Nowa nadzieja”), w którym nakreślili wizję nowej witryny. Dokument ten zawierał zestaw kluczowych zasad przewodnich:

  • Ujednolicona dokumentacja techniczna. Nowa witryna powinna skonsolidować dziesiątki witryn z dokumentacją hostowanych przez firmę Microsoft. Deweloper uczący się, jak utworzyć aplikację internetową opartą na danych, musiałby odwiedzić tylko jedną witrynę, aby znaleźć całą odpowiednią zawartość dla platform ASP.NET, Azure, Entity Framework lub innej technologii firmy Microsoft.
  • Ulepszone środowisko użytkownika końcowego. Kluczowym czynnikiem decydującym o sukcesie witryny internetowej jest środowisko, które zapewnia ona swoim klientom. Nowa witryna powinna charakteryzować się lepszą wydajnością ładowania, czytelnymi czcionkami, dostępnymi spisami treści, zrozumiałymi dla człowieka adresami URL, obsługą wersji, zgodnością z przeglądarkami dla urządzeń przenośnych oraz stosowaniem rozwiązań projektowania włączającego dzięki dostępnym funkcjom i obsłudze internacjonalizacji.
  • Demokratyzacja procesu tworzenia i zaangażowanie społeczności. Nowa witryna powinna być oparta na standardach i narzędziach typu open source, które umożliwiają każdemu tworzenie i edytowanie dokumentacji. Powinna używać języka znaczników Markdown dla zawartości, kodu YAML dla automatycznie generowanej dokumentacji interfejsów API i polegać na witrynie GitHub jako warstwie zawartości bazowej, co pozwoliłoby na używanie automatycznych mechanizmów kontroli jakości. Organizacja MicrosoftDocs w usłudze GitHub zwiększyła się do ponad 7400 członków, a repozytorium dokumentacji platformy Azure jest jednym z najszybciej rosnących projektów typu open source (470% rok do roku) i piątym najbardziej współtworzonym repozytorium spośród wszystkich w usłudze GitHub, jak widać w raporcie State of the Octoverse 2018.
  • Obsługa dokumentacji interfejsów API. Nowa witryna powinna mieć najwyższej klasy obsługę dokumentacji interfejsów API napisanych dla języków programowania i platform używanych przez naszych klientów, takich jak .NET, Java, Python, JavaScript i TypeScript, PowerShell, interfejs wiersza polecenia platformy Azure, Q#, OpenAPI i inne. Środowisko powinno opierać się na automatyzacji, mieć niezawodne pokrycie interfejsów API i być w stanie publikować dokumentację interfejsów API w ciągu kilku minut, a nie tygodni.
  • Modernizacja infrastruktury inżynierskiej. Witryna docs.microsoft.com powinna być uruchomiona na platformie Azure, co pozwala nam obniżyć koszty konserwacji (oszczędzono ponad 7 mld USD), skrócić cykle wdrażania z trzytygodniowych do codziennych (lub krótszych) i ograniczyć powielanie pracy inżynierskiej.
  • Domyślna rozszerzalność. W miarę rozwoju witryny musi być ona w stanie spełniać potrzeby naszych klientów w najbardziej wydajny sposób. Podejmując to zobowiązanie, byliśmy w stanie skompilować i zintegrować zupełnie nowe środowisko interaktywnego uczenia — Microsoft Learn, a także naszą przeglądarkę przykładowego kodu.

Dzięki nowoczesnej platformie mogliśmy upewnić się, że nie utracimy cennej zawartości, migrując ją do nowej witryny. Poniżej znajdziesz więcej informacji o naszych postępach.

Biblioteki MSDN i TechNet

Stan: ✅ Ukończono

Migrację biblioteki MSDN i biblioteki TechNet do witryny docs.microsoft.com rozpoczęliśmy pod koniec 2017 roku, a w tym roku ją ukończyliśmy.

Biblioteki wcześniej dostarczały dokumentację produktów Microsoft, w tym dokumentację interfejsu API, przykładowy kod i artykuły techniczne. Pierwotnie dostępna za pośrednictwem płyt CD zawartość została przeniesiona do Internetu po uruchomieniu witryn MSDN i TechNet.

Migracja wymagała konwersji różnych formatów opartych na XML na język Markdown w przypadku zawartości edytowanej przez ludzi i na pliki YAML w przypadku automatycznie generowanej dokumentacji interfejsów API, obejmującej ponad sto tysięcy różnych zestawów zawartości. Zapewniliśmy wdrożenie przekierowań stron w przypadku milionów stron internetowych, zapobiegając przerwaniu linków przywoływanych poza naszą witryną, takich jak blogi i fora.

Aby rzucić okiem na ilość zawartości, z którą pracowaliśmy, oto kilka statystyk:

Jeśli masz zakładki do jakiejkolwiek treści w witrynie MSDN lub TechNet, linki zostaną bezproblemowo przekierowane do jej nowej lokalizacji w witrynie docs.microsoft.com .

Magazyn MSDN Magazine

Stan: ✅ Ukończono

Ostatnie wydanie magazynu MSDN Magazine zostało opublikowane 1 listopada 2019 r. Wysłaliśmy wiadomość do czytelników i autorów w sierpniowym wydaniu magazynu MSDN Magazine.

Zawartość magazynu MSDN Magazine opublikowana w witrynie MSDN została przeniesiona do witryny docs.microsoft.com/archive.

Subskrybenci magazynu MSDN Magazine, którzy zapłacili za swoje subskrypcje, otrzymają proporcjonalny zwrot pieniędzy na podstawie czasu pozostałego w ramach subskrypcji. Czeki na kwotę zwrotu zostaną wysłane po opublikowaniu wydania listopadowego. Ta zmiana nie ma wpływu na subskrypcję platformy MSDN.

Biuletyny Microsoft Developer i TechNet Flash

Stan: ✅ Ukończono

Biuletyny opublikowane w witrynach MSDN i TechNet zostały przeniesione do witryny docs.microsoft.com/archive.

Aktualni subskrybenci będą nadal otrzymywać te biuletyny. Firma Microsoft może rozwijać i zmieniać format oraz harmonogram publikacji.

Jeśli nie chcesz już subskrybować naszych biuletynów, możesz anulować subskrypcję z poziomu następnej otrzymanej wiadomości e-mail.

Blogi MSDN i TechNet

Stan: ✅ Ukończono

W lipcu 2019 roku witryny blogów MSDN i blogów TechNet zmieniliśmy tak, aby były tylko do odczytu. Blogi MSDN i TechNet zostały zmigrowane i zarchiwizowane do docs.microsoft.com/archive.

Jeśli masz zakładki blogi MSDN lub TechNet, linki do nich zostaną przekierowane do nowej lokalizacji na docs.microsoft.com/archive lub do innych witryn blogów, jeśli są one aktywnie obsługiwane i aktualizowane blogi.

Stan: ✅ Ukończono

Przekierowaliśmy wszystkie strony galerii kodu MSDN do przeglądarki przykładów i zarchiwizowaliśmy najważniejsze przykłady w usłudze GitHub w organizacji MicrosoftArchive. Przeczytaj więcej na temat tego procesu w naszym ostatnim wpisie w blogu.

Najbardziej aktualne przykłady kodu można znaleźć na stronie docs.microsoft.com/samples.

Stan: 🚧 W toku

Galeria TechNet zostanie wycofana na początku 2020 roku. W grudniu 2019 roku witryna zostanie zmieniona na tylko do odczytu i nie będzie już akceptowała nowych materiałów przekazywanych przez społeczność. Wkrótce zostaną udostępnione dodatkowe ogłoszenia i informacje.

Najbardziej aktualne przykłady kodu można znaleźć na stronie docs.microsoft.com/samples. W przypadku wcześniejszej współpracy z Galerią TechNet przeprowadź migrację swoich przykładów do osobiście zarządzanej lokalizacji, takiej jak własne repozytorium GitHub.

Witryna TechNet Wiki

Stan: 🚧 W toku

Pracujemy nad bardziej konkretnym planem i harmonogramem migracji witryny TechNet Wiki. Zajrzyj tu później, aby uzyskać więcej informacji. W tej chwili możesz nadal współtworzyć zawartość stron typu wiki i korzystać z witryny.

Blogi MSDN i TechNet

Stan: 🚧 W toku

Ogłosiliśmy wersję zapoznawczą platformy Microsoft Q&A, która zastępuje fora MSDN i TechNet. Aby zapewnić sprawne przejście i zminimalizować ewentualne zakłócenia, migracja została podzielona na wiele etapów. Planujemy ukończenie migracji w połowie 2020 r. Zajrzyj tu później, aby uzyskać więcej informacji.

Channel9

Stan: 🚧 W toku

Witryna Channel 9 nadal stanowi ważną inwestycję na potrzeby zawartości wideo przeznaczonej dla deweloperów. Pracujemy nad ścieżką migracji, która zapewni lepszą integrację naszych filmów wideo i zawartości technicznej z witryny Channel 9. Zajrzyj tu później, aby uzyskać więcej informacji.

Chcemy poznać Twoją opinię

Będziemy w dalszym ciągu inwestować w naszą platformę, aby upewnić się, że otrzymujesz najbardziej odpowiednią i niezawodną dokumentację techniczną dla całego ekosystemu Microsoft. Przekaż nam swoje przemyślenia i sugestie dotyczące ulepszeń w usłudze GitHub i serwisie Twitter.