Importera och exportera en dokumentationswebbplats

Flytta ditt befintliga hjälpcenter till en Clevera-dokumentationswebbplats, eller ladda ner allt på en webbplats som en zipfil. Importen tar med sig sidor, bilder, struktur, översättningar och gamla adresser; exporten ger dig ditt innehåll som HTML- eller Markdown-filer. Båda är gratis.

Innan du börjar#

• Öppna din dokumentationswebbplats och gå till Inställningar → Import & export.
• Endast arbetsytans ägare kan importera eller exportera. Administratörer kan öppna fliken och titta runt, men dess kontroller är avstängda: "Endast arbetsytans ägare kan importera eller exportera innehåll."
• Import och export kostar inga krediter, oavsett plan.
• Importerade sidor är inte live förrän du publicerar, så du kan granska dem först.

Importera dina dokument#

1. Välj din plattform#

   Under Importera innehåll, klicka på plattformen där dina dokument finns. Om den inte finns med i listan, välj Vilken annan dokumentationswebbplats som helst.

   

2. Anslut#

   Välj hur du vill ansluta under Hur du ansluter, fyll i fälten och klicka på Kontrollera anslutning. Se Plattformar och metoder för vad som krävs för varje alternativ.

3. Förhandsgranska#

   Clevera listar sektionerna och sidorna som hittades. Avmarkera sidor du inte vill ha. En stor webbplats kan ta en minut: "Vi listar varje sektion och sida."

4. Välj alternativen#

   Välj var sidorna ska hamna och vilka språk som ska följa med. Se Importalternativ.

5. Bekräfta och starta#

   Kontrollera sammanfattningen, till exempel "Vi kommer att kopiera 120 sidor till ett nytt avsnitt, “Hjälpcenter”." och den Beräknade tiden, klicka sedan på Starta import.

Du kan stänga fönstret medan den körs: "Du kan stänga det här fönstret. Vi skickar ett e-postmeddelande när importen är klar." Förloppet visar Importerar sidor, Kopierar bilder, Länka sidor och Lägger till omdirigeringar, med antal för Sidor, Bilder och Misslyckades.

När den är klar får du ett e-postmeddelande, "Din import från plattform är klar", med Visa rapporten. Granska sedan sidorna och publicera webbplatsen.

Plattformar och metoder#

Varje plattformskort visar vilka metoder som stöds: API-anslutning, Offentlig webbplats och Databas / zip.

Metoderna#

Offentlig webbplats. Klistra in adressen till dina offentliga dokument (startsidan eller valfri dokumentsida) under Webbplatsadress. Clevera läser sidorna som listas i navigeringen eller webbplatskartan, i en lugn takt som respekterar din robots.txt. Endast sidor under den adressen läses in. Privata artiklar och utkast inkluderas inte.

API-token eller nyckel. Klistra in en token som du skapar i den andra plattformen. Varje plattformskort har stegen och en länk till var du skapar den. Clevera läser endast. Tokens används medan importen körs och raderas inom 24 timmar. Du kan återkalla token i den andra plattformen när importen är klar.

Git-databas. Klistra in Databasadress (GitHub, GitLab eller Bitbucket). För en privat GitHub-databas, lägg till en Åtkomsttoken med skrivskyddad åtkomst till innehåll. Clevera laddar ner standardgrenen som ett arkiv och kör aldrig dess kod.

Ladda upp en zipfil. Ladda upp en .zip med dina dokument, upp till 200 MB. Clevera läser Markdown, MDX, JSON, YAML och bilder och ignorerar allt annat. För Vilken annan dokumentationswebbplats som helst kan zipfilen innehålla .md, .mdx eller .html-filer, och varje mapp på toppnivå blir en sektion.

Plattformsspecifika anteckningar#

• Intercom tillåter inte delning av åtkomsttokens med andra appar, så Clevera läser ditt offentliga hjälpcenter.
• Zendesk API-åtkomst kräver en administratör på en plan från Team och uppåt. Alla agenter läser publicerade artiklar; en Guide-administratör tar även med utkast och begränsade artiklar.
• Help Scout låter dig välja Endast publicerade artiklar eller Publicerade artiklar och utkast. Dess API-nycklar kan inte vara skrivskyddade, så radera nyckeln efteråt.
• ReadMe API-referenssidor, recept och anpassade sidor stannar på ReadMe.
• Document360 API-åtkomst finns på deras Business- och Enterprise-planer och kräver en nyare API-nyckel.
• Notion kräver att arbetsytans ägare skapar anslutningen, med "Läs endast innehåll".
• Confluence fungerar med Confluence Cloud-webbplatser.
• Dokument med flera versioner: endast den nyaste versionen importeras.

Importalternativ#

För metoden Offentlig webbplats markerar du även "Jag äger detta innehåll eller har rätt att kopiera det." innan du startar.

Hur strukturen flyttas över#

• Sidor, bilder, sektioner, grupper, översättningar, omdirigeringar och ändringsloggposter importeras.
• Dokumentationswebbplatser har sektioner med en nivå av grupper under sig. Djupare nivåer flyttas upp en nivå, med en varning i rapporten.
• Importerade sidor är redo att publiceras; de blir live vid nästa publicering. Importerade ändringsloggposter kommer in som utkast.
• Bilder kopieras till webbplatsen. En bild som inte kan kopieras utelämnas med en varning, och dess alt-text stannar kvar.
• Länkar mellan importerade sidor pekar mot deras nya adresser. Länkar till sidor som inte importerades behåller sina ursprungliga adresser.
• Sidor som endast hittas i webbplatskartan, inte i menyn, hamnar i en grupp som heter "Fler sidor".

Begränsningar#

Kortet visar hur många importer som finns kvar idag och sidgränsen.

Importrapporten#

Klicka på Visa rapport under Senaste importer. Rapporten visar sektionen och summor för Importerad, Överhoppad, Misslyckades, Bilder och Omdirigeringar. Filtrera sidorna efter Misslyckades, Med varningar eller Överhoppad, och klicka på Öppna i editorn för att åtgärda en.

Exempel på varningar:

• "Den här sidan var kapslad djupare än vad dokumentationswebbplatser tillåter, så den flyttades upp en nivå."
• "En bild kunde inte kopieras, så den utelämnades"
• "En sida med denna adress finns redan här, så den hoppades över."
• "Överhoppad: robots.txt eller webbplatsens adressregler hindrar oss från att läsa den här sidan."

Ångra eller avbryt en import#

• Avbryt import stoppar efter sidorna som läses just nu. Sidor som redan importerats stannar kvar, och du kan ångra dem från rapporten.
• Ångra import raderar sidorna, bilderna, omdirigeringarna och ändringsloggposterna som importen skapade, samt dess nya sektion om den nu är tom.

Exportera en webbplats#

1. Välj ett format#

   Under Exportera din data, välj Exportformat: HTML (sidor du öppnar i en webbläsare, bilder i en egen mapp) eller Markdown (vanliga .md-filer, bilder i en egen mapp).

   

2. Begär den#

   Klicka på Begär export. Du ser "Export begärd. Vi skickar en nedladdningslänk till" din adress, "vanligtvis inom 10 minuter".

3. Ladda ner den#

   Öppna e-postmeddelandet "Din export av site är klar" och klicka på Ladda ner export. Du måste vara inloggad på Clevera. Länken fungerar i 7 dagar; exporten visas även under kortet med Ladda ner tills den löper ut.

Zip-filen innehåller:

• Varje sida på webbplatsen, inklusive utkast markerade som "Draft", på alla språk, även webbplatssidor.
• Ändringsloggen, inklusive utkast.
• Bilder, där varje bild lagras en gång.
• Navigeringen, webbplatsinställningar, omdirigeringar (redirects.csv) och en lista över videor (videos.csv), med en README.txt som förklarar filerna.

Du kan begära 3 exporter per webbplats och dag (en rullande 24-timmarsperiod). En misslyckad export räknas inte. Endast den person som begärde en export kan ladda ner den. När ägaren exporterar får administratörer ett meddelande om att en export har gjorts.

Videor#

Videor finns inte med i zip-filen. I filerna är varje video en länk: "Titta på / exportera denna video". Kortet Videor listar varje Clevera-video på webbplatsens sidor med Exportera video, vilket öppnar videon så att du kan exportera den i önskad kvalitet.

Felsökning#

Relaterat#