Importuj i eksportuj witrynę z dokumentacją

Przenieś swoje istniejące centrum pomocy do witryny z dokumentacją Clevera lub pobierz całą zawartość witryny jako plik zip. Importy przenoszą strony, obrazy, strukturę, tłumaczenia i stare adresy; eksporty udostępniają zawartość w postaci plików HTML lub Markdown. Obie operacje są bezpłatne.

Zanim zaczniesz#

• Otwórz swoją witrynę z dokumentacją i przejdź do Ustawienia → Importuj zawartość.
• Tylko właściciel obszaru roboczego może importować lub eksportować dane. Administratorzy mogą otworzyć kartę i przejrzeć opcje, ale kontrolki są wyłączone: „Tylko właściciel obszaru roboczego może importować lub eksportować zawartość”.
• Importowanie i eksportowanie nie kosztuje żadnych kredytów, niezależnie od planu.
• Zaimportowane strony nie są publiczne, dopóki ich nie opublikujesz, dzięki czemu możesz je najpierw przejrzeć.

Importuj swoją dokumentację#

1. Wybierz platformę#

   W sekcji Importuj zawartość kliknij platformę, na której znajduje się Twoja dokumentacja. Jeśli nie ma jej na liście, wybierz Dowolna inna witryna z dokumentacją.

   

2. Połącz#

   Wybierz sposób połączenia w sekcji Jak połączyć, wypełnij pola i kliknij Sprawdź połączenie. Zobacz Platformy i metody, aby dowiedzieć się, co jest wymagane w każdym przypadku.

3. Podgląd#

   Clevera wyświetli listę znalezionych sekcji i stron. Odznacz strony, których nie chcesz importować. W przypadku dużej witryny może to potrwać chwilę: „Wyświetlamy każdą sekcję i stronę”.

4. Wybierz opcje#

   Wybierz miejsce docelowe stron oraz języki, które chcesz przenieść. Zobacz Opcje importu.

5. Potwierdź i rozpocznij#

   Sprawdź podsumowanie, na przykład „Skopiujemy 120 stron do nowej sekcji „Centrum pomocy”.” oraz Szacowany czas, a następnie kliknij Rozpocznij import.

Możesz zamknąć okno w trakcie trwania procesu: „Możesz zamknąć to okno. Wyślemy wiadomość e-mail, gdy import się zakończy”. Postęp pokazuje Importowanie stron, Kopiowanie obrazów, Łączenie stron i Dodawanie przekierowań, wraz z liczbą Stron, Obrazów i Niepowodzeń.

Po zakończeniu otrzymasz wiadomość e-mail „Twój import z platformy jest gotowy” z przyciskiem Wyświetl raport. Następnie przejrzyj strony i opublikuj witrynę.

Platformy i metody#

Każda karta platformy pokazuje obsługiwane metody: API, Strona publiczna oraz Repozytorium / zip.

Metody#

Strona publiczna. Wklej adres swojej publicznej dokumentacji (strony głównej lub dowolnej strony dokumentacji) w polu Adres strony. Clevera odczytuje strony wymienione w nawigacji lub mapie witryny w tempie, które szanuje Twój plik robots.txt. Odczytywane są tylko strony znajdujące się pod tym adresem. Prywatne artykuły i szkice nie są uwzględniane.

Token lub klucz API. Wklej token utworzony na drugiej platformie. Każda karta platformy zawiera instrukcje i link do miejsca, w którym można go utworzyć. Clevera tylko odczytuje dane. Tokeny są używane podczas importu i usuwane w ciągu 24 godzin. Po zakończeniu importu możesz unieważnić token na drugiej platformie.

Repozytorium Git. Wklej Adres repozytorium (GitHub, GitLab lub Bitbucket). W przypadku prywatnego repozytorium GitHub dodaj Token dostępu z uprawnieniami tylko do odczytu zawartości. Clevera pobiera domyślną gałąź jako archiwum i nigdy nie uruchamia zawartego w niej kodu.

Prześlij plik zip. Prześlij plik .zip ze swoją dokumentacją, do 200 MB. Clevera odczytuje pliki Markdown, MDX, JSON, YAML oraz obrazy, ignorując wszystko inne. W przypadku Dowolnej innej witryny z dokumentacją plik zip może zawierać pliki .md, .mdx lub .html, a każdy folder najwyższego poziomu staje się sekcją.

Uwagi dotyczące platform#

• Intercom nie pozwala na udostępnianie tokenów dostępu innym aplikacjom, więc Clevera odczytuje Twoje publiczne centrum pomocy.
• Dostęp do API Zendesk wymaga administratora w planie od Team wzwyż. Każdy agent odczytuje opublikowane artykuły; administrator Guide importuje również szkice i artykuły ograniczone.
• Help Scout pozwala wybrać Tylko opublikowane artykuły lub Opublikowane artykuły i szkice. Jego klucze API nie mogą być tylko do odczytu, więc usuń klucz po zakończeniu.
• Strony referencyjne API, przepisy i strony niestandardowe ReadMe pozostają na ReadMe.
• Dostęp do API Document360 jest dostępny w planach Business i Enterprise i wymaga nowszego klucza API.
• Notion wymaga, aby właściciel obszaru roboczego utworzył połączenie z uprawnieniem „Tylko odczyt zawartości”.
• Confluence współpracuje z witrynami Confluence Cloud.
• Dokumentacja z wieloma wersjami: importowana jest tylko najnowsza wersja.

Opcje importu#

W przypadku metody Strona publiczna przed rozpoczęciem zaznacz również „Jestem właścicielem tej zawartości lub mam prawo do jej kopiowania”.

Jak przenoszona jest struktura#

• Importowane są strony, obrazy, sekcje, grupy, tłumaczenia, przekierowania i wpisy dziennika zmian.
• Witryny z dokumentacją mają sekcje z jednym poziomem grup pod nimi. Głębsze poziomy są przenoszone o poziom wyżej, z ostrzeżeniem w raporcie.
• Zaimportowane strony są gotowe do publikacji; stają się publiczne przy następnej publikacji. Zaimportowane wpisy dziennika zmian są dodawane jako szkice.
• Obrazy są kopiowane do witryny. Obraz, którego nie można skopiować, jest pomijany z ostrzeżeniem, a jego tekst alternatywny zostaje zachowany.
• Linki między zaimportowanymi stronami są kierowane na ich nowe adresy. Linki do stron, które nie zostały zaimportowane, zachowują swoje oryginalne adresy.
• Strony znalezione tylko w mapie witryny, a nie w menu, trafiają do grupy o nazwie „Więcej stron”.

Limity#

Karta pokazuje, ile importów pozostało na dziś oraz limit stron.

Raport z importu#

Kliknij Wyświetl raport w sekcji Ostatnie importy. Raport pokazuje sekcję oraz sumy dla Zaimportowano, Pominięto, Niepowodzenie, Obrazy i Przekierowania. Filtruj strony według Niepowodzenie, Z ostrzeżeniami lub Pominięto i kliknij Otwórz w edytorze, aby naprawić wybraną stronę.

Przykłady ostrzeżeń:

• „Ta strona była zagnieżdżona głębiej, niż pozwalają na to witryny z dokumentacją, więc została przeniesiona o poziom wyżej.”
• „Obrazu nie można było skopiować, więc został pominięty”
• „Strona z tym adresem już tutaj istnieje, więc została pominięta.”
• „Pominięto: robots.txt lub zasady adresów witryny uniemożliwiają nam odczytanie tej strony.”

Cofnij lub anuluj import#

• Anuluj import zatrzymuje proces po zakończeniu odczytywania bieżącej strony. Strony już zaimportowane pozostają, a Ty możesz je cofnąć z poziomu raportu.
• Cofnij import usuwa strony, obrazy, przekierowania i wpisy dziennika zmian utworzone przez import, a także nową sekcję, jeśli jest teraz pusta.

Eksportuj witrynę#

1. Wybierz format#

   W sekcji Eksportuj swoje dane wybierz Format eksportu: HTML (strony otwierane w przeglądarce, obrazy we własnym folderze) lub Markdown (zwykłe pliki .md, obrazy we własnym folderze).

   

2. Zażądaj eksportu#

   Kliknij Poproś o eksport. Zobaczysz komunikat „Eksport został zlecony. Wyślemy link do pobrania na Twój adres e-mail”, zazwyczaj w ciągu 10 minut.

3. Pobierz go#

   Otwórz wiadomość e-mail „Twój eksport site jest gotowy” i kliknij Pobierz eksport. Musisz być zalogowany do Clevera. Link jest ważny przez 7 dni; eksport będzie również widoczny pod kartą z przyciskiem Pobierz do momentu wygaśnięcia.

Plik zip zawiera:

• Każdą stronę w witrynie, w tym wersje robocze oznaczone jako „Draft”, w każdym języku, a także strony witryny.
• Dziennik zmian, w tym wersje robocze.
• Obrazy, z których każdy jest przechowywany tylko raz.
• Nawigację, ustawienia witryny, przekierowania (redirects.csv) oraz listę wideo (videos.csv), wraz z plikiem README.txt wyjaśniającym zawartość plików.

Możesz zlecić 3 eksporty na witrynę dziennie (w trybie kroczącym 24-godzinnym). Nieudany eksport nie wlicza się do tego limitu. Tylko osoba, która zleciła eksport, może go pobrać. Gdy właściciel zleca eksport, administratorzy otrzymują powiadomienie o jego wykonaniu.

Wideo#

Wideo nie znajdują się w pliku zip. W plikach każde wideo jest linkiem: „Obejrzyj / eksportuj to wideo”. Karta Wideo zawiera listę wszystkich wideo Clevera na stronach witryny wraz z przyciskiem Eksportuj wideo, który otwiera wideo, umożliwiając jego eksport w wybranej jakości.

Rozwiązywanie problemów#

Powiązane#